Appendix A: Common Types
Common and supporting types referenced in this specification are included here as a reference.
A.1 AcademicAttainmentGoalListType
The academic attainment goals of the student when they
enrolment, e.g. they wish to achieve a certain
qualification.
Figure A.1-1: AcademicAttainmentGoalListType
Element/@Attribute Char Description Type AcademicAttainmentGoalListType The academic attainment goals of the student when they
enrolment, e.g. they wish to achieve a certain
qualification.
MR The student's academic attainment goal at the time of enrolment.
ObjectReferenceType
Table A.1-1: AcademicAttainmentGoalListType
A.2 AcademicDayListType
A list of the academic days within this schedule
Figure A.2-1: AcademicDayListType
Element/@Attribute Char Description Type AcademicDayListType A list of the academic days within this schedule
List MR An academic day that is part of this schedule.
AcademicDayType
Table A.2-1: AcademicDayListType JSON {
"AcademicDayList": {
"AcademicDay": [
{
"RefId": "364f0aa5-49e2-434e-9c82-45770f4c71a9",
"LocalId": "2019a-A",
"Name": "Schedule 2019a, Day A",
"PeriodList": {
"Period": [
{
"RefId": "215f796c-67f7-4855-83dc-28ad9d002830",
"LocalId": "2019a-A1",
"Name": "Period 1 on Day A"
},
{
"RefId": "1c48a0bb-a6cc-41ab-8aae-929ce5ec9c34",
"LocalId": "2019a-A2",
"Name": "Period 2 on Day A"
}
]
}
},
{
"RefId": "337804c6-1247-4c0f-b288-e4aa28584aad",
"LocalId": "2019a-B",
"Name": "Schedule 2019a, DayB",
"PeriodList": {
"Period": [
{
"RefId": "f6776718-4680-4cb7-b649-a84f9796905c",
"LocalId": "2019a-B1",
"Name": "Period 1 on Day B"
},
{
"RefId": "0ddaa486-adf1-4cb3-bd06-71397f4bbdd9",
"LocalId": "2019a-B2",
"Name": "Period 2 on Day B"
}
]
}
}
]
}
}
Example A.2-1: AcademicDayList Example
A.3 AcademicDayType
An academic day that is part of this schedule
Figure A.3-1: AcademicDayType
Element/@Attribute Char Description Type AcademicDayType An academic day that is part of this schedule
Extension of ObjectReferenceType O The GUUID of the referenced object
IdRefType O Local identifier representing the referenced object.
LocalIdType O The normal descriptive name of the referenced object.
xs:string O The type of the referenced object:
NZCodeSetsReferrableDataObjectsType O The bell schedule this academic day is following.
ObjectReferenceType M A list of the periods that make up this academic day, e.g. Period 1, Period 2 etc.
PeriodListType
Table A.3-1: AcademicDayType JSON {
"AcademicDay": {
"RefId": "364f0aa5-49e2-434e-9c82-45770f4c71a9",
"LocalId": "2019a-A",
"Name": "Schedule 2019a, Day A",
"BellSchedule": {
"RefId": "8bda1e4a-ddd2-4d18-9a85-ffcd7a2528b8",
"Name": "Schedule 2019a, Normal Bell Schedule"
},
"PeriodList": {
"Period": [
{
"RefId": "215f796c-67f7-4855-83dc-28ad9d002830",
"LocalId": "2019a-A1",
"Name": "Period 1 on Day A"
},
{
"RefId": "1c48a0bb-a6cc-41ab-8aae-929ce5ec9c34",
"LocalId": "2019a-A2",
"Name": "Period 2 on Day A"
}
]
}
}
}
Example A.3-1: AcademicDay Example
A.4 AcademicGoalListType
A list of academic goals the student has set.
Figure A.4-1: AcademicGoalListType
Element/@Attribute Char Description Type AcademicGoalListType A list of academic goals the student has set.
List MR
AcademicGoalType
Table A.4-1: AcademicGoalListType Example A.4-1: AcademicGoalList
A.5 AcademicGoalType
Defining elements of the Academic flavour of student goal.
Figure A.5-1: AcademicGoalType
Element/@Attribute Char Description Type AcademicGoalType Defining elements of the Academic flavour of student goal.
Extension of BaseStudentGoalType O The date the Student's goal was recorded.
xs:date O The date the Student achieved their goal.
xs:date O A description of the goal the student wants to achieve
xs:normalizedString O The name of the goal the student wants to achieve
xs:normalizedString O The subject are athe student's academic goal is for.
NZCodeSetsSubjectAreaType
Table A.5-1: AcademicGoalType
A.6 AcknowledgementListType
A list of the providers and staff who have been sent the alerts and have acknowledged they have been read.
Figure A.6-1: AcknowledgementListType
Element/@Attribute Char Description Type AcknowledgementListType A list of the providers and staff who have been sent the alerts and have acknowledged they have been read.
List MR AcknowledgementType
Table A.6-1: AcknowledgementListType
A.7 AcknowledgementType
A provider or staff member that has been sent the alerts and have acknowledged they have been read.
Figure A.7-1: AcknowledgementType
Element/@Attribute Char Description Type AcknowledgementType A provider or staff member that has been sent the alerts and have acknowledged they have been read.
M Indicates whether or not a staff member has viewed the alerts.
NZCodeSetsYesOrNoCategoryType M The date the provider acknowledged a staff member has viewed the alerts.
xs:date O A provider who has been sent the alerts and have acknowledged they have been read.
ObjectReferenceType O A staff member who has been sent the alerts and have acknowledged they have been read.
ObjectReferenceType
Table A.7-1: AcknowledgementType
A.8 ActionTakenListType
A list of the actions taken as a result of this Wellbeing event.
Figure A.8-1: ActionTakenListType
Element/@Attribute Char Description Type ActionTakenListType A list of the actions taken as a result of this Wellbeing event.
List MR The action taken as a result of this Wellbeing event.
NZCodeSetsWellbeingEventActionTakenType
Table A.8-1: ActionTakenListType
A.9 AddressListType
A list of Address elements.
Figure A.9-1: AddressListType
Element/@Attribute Char Description Type AddressListType A list of Address elements.
List MR AddressType
Table A.9-1: AddressListType JSON {
"AddressList": {
"Address": [
{
"Type": "DE",
"Role": "POS",
"Line1": "P O Box 81",
"City": "Martinborough",
"PostalCode": "5741"
},
{
"Type": "RU",
"Role": "PHY",
"Line1": "1175 Lake Ferry Rd",
"Suburb": "RD 1",
"City": "Martinborough",
"PostalCode": "5781"
}
]
}
}
Example A.9-1: Address List Example
A.10 AddressType
This element contains address data
Figure A.10-1: AddressType
Element/@Attribute Char Description Type AddressType This element contains address data.
O Code defining the class of the address: Urban, Rural, Delivery Service or Foreign.
NZCodeSetsAddressTypeType O Describes how the Person/Organisation uses the Address
NZCodeSetsAddressRoleType M Address line 1.
xs:normalizedString O Address line 2.
xs:normalizedString O Address line 3.
xs:normalizedString O Address line 4.
xs:normalizedString O The suburb part of urban addresses, or the 'RD No' part of rural addresses
xs:normalizedString O The city part of the address.
xs:normalizedString C The state or province code. StateTerritory Code only applicable if a non-New Zealand Address.
xs:string O The country code.
xs:string O The ZIP/postal code.
xs:normalizedString O 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)
GridLocationType O A list of Statistical Areas containing the location.
The list may contain exactly one StatisticalArea
element for each of the following spatial unit types:
Ward Urban Area Census Area Unit Māori Electorate Mesh Block General Electorate Territorial Authority Local Board (Auckland Only) Regional Council StatisticalAreaListType
Table A.10-1: AddressType Example A.10-1: NZ Street Postal Address Example Example A.10-2: NZ P O Box Postal Address Example Example A.10-3: NZ Rural Residential Address Example
A.11 AssessmentResultScoreListType
A list of scores for the assessment task result.
Figure A.11-1: AssessmentResultScoreListType
Element/@Attribute Char Description Type AssessmentResultScoreListType A list of scores for the assessment task result.
List MR An Assessment Result Score that is a member of the related AssessmentResultScoreList.
AssessmentResultScoreType
Table A.11-1: AssessmentResultScoreListType Example A.11-1: PAT Result Score List Example JSON {
"ResultScoreList": {
"ResultScore": [
{
"Competency": "Ideas",
"ScoreMetric": "RAW",
"ScoreValue": "1234"
},
{
"Competency": "Ideas",
"ScoreMetric": "CUR",
"ScoreValue": "5B"
},
{
"Competency": "Overall",
"ScoreMetric": "RAW",
"ScoreValue": "1591"
},
{
"Competency": "Overall",
"ScoreMetric": "CUR",
"ScoreValue": "5B"
}
]
}
}
Example A.11-2: asTTle Result Score List Example
A.12 AssessmentResultScoreType
An individual result score for the assessment task.
Figure A.12-1: AssessmentResultScoreType
Element/@Attribute Char Description Type AssessmentResultScoreType An individual result score for the assessment task.
O 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.
NZCodeSetsScoreTypeType O String describing a particular competency that is being reported in the assessment.
xs:normalizedString O A code denoting the type of metric the ScoreValue represents.
NZCodeSetsScoreMetricType O 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.
xs:normalizedString O The maximum value possible for the score. xs:decimal O 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.
xs:int
Table A.12-1: AssessmentResultScoreType
A.13 AssessmentTaskListType
Figure A.13-1: AssessmentTaskListType
Element/@Attribute Char Description Type AssessmentTaskListType List MR GUID that identifies the sub-ordinate AssessmentTask.
ObjectReferenceType
Table A.13-1: AssessmentTaskListType
A.14 AttendanceTimeListType
Breakdown of times that the student entered or returned to school.
Figure A.14-1: AttendanceTimeListType
Element/@Attribute Char Description Type AttendanceTimeListType Breakdown of times that the student entered or returned to school.
List MR
AttendanceTimeType
Table A.14-1: AttendanceTimeListType JSON {
"AttendanceTimeList": {
"AttendanceTime": [
{
"AttendanceTimeLocalId": "7f11e3ed-3ac5-4673-9fdc-bcdbcd934554",
"AttendanceType": "SCH",
"Code": "P",
"AttendanceDate": "2018-06-26",
"SchedulePeriod": {
"RefId": "7f11e3ed-3ac5-4673-9fdc-bcdbcd999999"
},
"SubmissionDateTime": "2018-06-30T06:30:57",
"Note": "Student was present.",
"RecordAudit": {
"LastUpdatedDateTime": "2018-06-28T06:30:57"
}
},
{
"AttendanceTimeLocalId": "7f11e3ed-3ac5-4673-9fdc-bcdbcd934667",
"AttendanceType": "ADH",
"Code": "E",
"AttendanceDate": "2018-06-27",
"StartTime": "09:45:00",
"EndTime": "10:30:00",
"SubmissionDateTime": "2018-06-30T06:30:57",
"Note": "Explained absence, but unjustified.",
"RecordAudit": {
"LastUpdatedDateTime": "2018-06-28T06:30:57"
}
}
]
}
}
Example A.14-1: Attendance Time List
A.15 AttendanceTimeType
Time span that the student entered or returned to school
Figure A.15-1: AttendanceTimeType
Element/@Attribute Char Description Type AttendanceTimeType Time span that the student entered or returned to school
M The source system identifier of the attendance time list record.
LocalId M 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.
NZCodeSetsAttendanceTypeType O The attendance code group the students attendance code belongs to.
NZCodeSetsAttendanceCodeGroupType M MoE defined code for attendance or absence during the time period described.
NZCodeSetsAttendanceCodeType M The date the attendance is being record for.
xs:date O The scheduled period this attendnance time list record is for. The SchedulePeriod must be provided if the AttendanceType = 'Scheduled'.
ObjectReference O The Start Time of the students attendance for the provided Attendance Date. Mandatory for attendance records with a type of 'Ad Hoc'.
xs:time O The End Time of the students attendance for the provided Attendance Date. Mandatory for attendance records with a type of 'Ad Hoc'.
xs:time O The date the students attendance for this date and time/period was submitted.
xs:dateTime O Free text note about the students attendance for the provided date and time/period.
xs:normalizedString O The audit details for a record, e.g. Created/Last Updated DateTime and Created/Last Updated By.
RecordAuditType
Table A.15-1: AttendanceTimeType
A.16 AttendeeListType
The type of debriefing that occurred, e.g. staff, or student and parent/caregiver.
Figure A.16-1: AttendeeListType
Element/@Attribute Char Description Type AttendeeListType The type of debriefing that occurred, e.g. staff, or student and parent/caregiver.
List MR A person that attended the debriefing.
ObjectReferenceType
Table A.16-1: AttendeeListType
A.17 AwardContainerType
Container for details of an Award, where this response was in relation to a particular Award.
Figure A.17-1: AwardContainerType
Element/@Attribute Char Description Type AwardContainerType Container for details of an Award, where this response was in relation to a particular Award.
O Date when to be awarded.
xs:date O Type of Award.
NZCodeSetsWellbeingAwardTypeType O Description of the Award.
xs:string O Any comments/notes associated with the Award.
xs:string
Table A.17-1: AwardContainerType
A.18 BaseCommunicationChannelType
A set of attributes common to multiple kinds of communication channel
Figure A.18-1: BaseCommunicationChannelType
Element/@Attribute Char Description Type BaseCommunicationChannelType A set of attributes common to multiple kinds of communication channel
BaseCommunicationChannelType is the base type for the following data types: O Notes on when / how to use the communication channel. eg: Phone after 4pm
xs:string O Preference number indicating an order in which communication channels should be used
when contacting person or organisation.
xs:unsignedInt O A code describing the acceptable usage of a person or organisation's communication channel
NZCodeSetsCommunicationUsageType
Table A.18-1: BaseCommunicationChannelType
A.19 BaseNameType
Base type, without attributes, for Name elements, primarily to allow structure to be leveraged with different Type attribute values.
Figure A.19-1: BaseNameType
Element/@Attribute Char Description Type BaseNameType Base type, without attributes, for Name elements, primarily to allow structure to be leveraged with different Type attribute values.
BaseNameType is the base type for the following data types: O A title or prefix associated with the name.
xs:normalizedString C Also known as Last Name, although some cultures may not present a family name as the last name.
xs:normalizedString C 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.
xs:normalizedString O Where more than one Given Name, these may be combined
in one composite field or else populated in several
elements.
xs:normalizedString O 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.
NZCodeSetsYesOrNoCategoryType O 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’.
xs:normalizedString O 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.
NZCodeSetsYesOrNoCategoryType O 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’.
xs:normalizedString O Textual suffix like PHD, JP, BSc.
xs:normalizedString C A combination of all name elements as one composite text element
xs:normalizedString O
Where a person has more than one name, the usage type
distinguishes the purposes or their preference for use of
the name.
NZCodeSetsNameUsageTypeType O
Flag indicating that this name has been verified.
NZCodeSetsYesOrNoCategoryType
Table A.19-1: BaseNameType Example A.19-2: Base Name Example
A.20 BaseStudentGoalType
Base complex type defining elements common to all flavours of StudentGoal.
Figure A.20-1: BaseStudentGoalType
Element/@Attribute Char Description Type BaseStudentGoalType Base complex type defining elements common to all flavours of StudentGoal.
BaseStudentGoalType is the base type for the following data types: O The date the Student's goal was recorded.
xs:date O The date the Student achieved their goal.
xs:date O A description of the goal the student wants to achieve
xs:normalizedString O The name of the goal the student wants to achieve
xs:normalizedString
Table A.20-1: BaseStudentGoalType
A.21 BehaviourDirectedAtListType
The list of the people and/or property that the student, who was restrained, was directing their behaviour at.
Figure A.21-1: BehaviourDirectedAtListType
Element/@Attribute Char Description Type BehaviourDirectedAtListType The list of the people and/or property that the student, who was restrained, was directing their behaviour at.
List MR The person and/or piece of property that the student, who was restrained, was directing their behaviour at.
BehaviourDirectedAtType
Table A.21-1: BehaviourDirectedAtListType
A.22 BehaviourDirectedAtType
The person and/or piece of property that the student, who was restrained, was directing their behaviour at.
Figure A.22-1: BehaviourDirectedAtType
Element/@Attribute Char Description Type BehaviourDirectedAtType The person and/or piece of property that the student, who was restrained, was directing their behaviour at.
O The person the student's behaviour was directed at.
ObjectReferenceType O Free text describing the behaviour the student showed towards a person of piece of property.
xs:normalizedString O Code set denoting type of object or person the student was directing their behaviour at, e.g. Staff Member, Student, Desk, Chair.
NZCodeSetsBehaviourDirectedAtTypeType
Table A.22-1: BehaviourDirectedAtType
A.23 BehaviourIdentifiedListType
A list of the problem behaviours identified for the student as a result of the Wellbeing Event. There are both minor and major behaviours.
Figure A.23-1: BehaviourIdentifiedListType
Element/@Attribute Char Description Type BehaviourIdentifiedListType A list of the problem behaviours identified for the student as a result of the Wellbeing Event. There are both minor and major behaviours.
List MR The type of minor problem behaviour identified as a result of the Wellbeing Event.
BehaviourIdentifiedType
Table A.23-1: BehaviourIdentifiedListType
A.24 BehaviourIdentifiedType
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.
Figure A.24-1: BehaviourIdentifiedType
Element/@Attribute Char Description Type BehaviourIdentifiedType 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.
O The severity of the Wellbeing Event.
NZCodeSetsWellbeingEventSeverityType OR The type of minor problem behaviour identified as a result of the Wellbeing Event.
NZCodeSetsWellbeingEventMinorBehaviourType OR The type of major problem behaviour identified as a result of the Wellbeing Event.
NZCodeSetsWellbeingEventMajorBehaviourType
Table A.24-1: BehaviourIdentifiedType
A.25 BellScheduleListType
A list of BellSchedule object references.
Figure A.25-1: BellScheduleListType
Element/@Attribute Char Description Type BellScheduleListType A list of BellSchedule object references.
List MR Generic object reference to a BellSchedule in the list
ObjectReferenceType
Table A.25-1: BellScheduleListType
A.26 CareerGoalListType
A list of career goals the student has set.
Figure A.26-1: CareerGoalListType
Element/@Attribute Char Description Type CareerGoalListType A list of career goals the student has set.
List MR
BaseStudentGoalType
Table A.26-1: CareerGoalListType Example A.26-1: CareerGoalList
A.27 ClassStrandListType
A record of the Student's progress in a set of learning strands
from the Technology curriculum, that were covered in the class.
Figure A.27-1: ClassStrandListType
Element/@Attribute Char Description Type ClassStrandListType A record of the Student's progress in a set of learning strands
from the Technology curriculum, that were covered in the class.
List MR A record of the Student's progress in a particular learning strand
from the Technology curriculum, that was covered in the class.
ClassStrandType
Table A.27-1: ClassStrandListType
A.28 ClassStrandType
A record of the Student's progress in a particular learning strand
from the Technology curriculum, that was covered in the class.
Figure A.28-1: ClassStrandType
Element/@Attribute Char Description Type ClassStrandType A record of the Student's progress in a particular learning strand
from the Technology curriculum, that was covered in the class.
M 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.
NZCodeSetsTechnologyLearningStrandType O 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.
StrandAchievementObjectiveListType
Table A.28-1: ClassStrandType
A.29 CommunicationChannelListType
A list of people/organisation's ccommunications channels
Figure A.29-1: CommunicationChannelListType
Element/@Attribute Char Description Type CommunicationChannelListType A list of people/organisation's ccommunications channels
List MR CommunicationChannelType
Table A.29-1: CommunicationChannelListType
A.30 CommunicationChannelType
A particular person or organisation's communications method
Figure A.30-1: CommunicationChannelType
Element/@Attribute Char Description Type CommunicationChannelType A particular person or organisation's communications method
Extension of BaseCommunicationChannelType O Notes on when / how to use the communication channel. eg: Phone after 4pm
xs:string O Preference number indicating an order in which communication channels should be used
when contacting person or organisation.
xs:unsignedInt O A code describing the acceptable usage of a person or organisation's communication channel
NZCodeSetsCommunicationUsageType O A code classifying the Communication's method
NZCodeSetsCommunicationChannelTypeType M The unique value that provides access to the channel. eg: URL for a website;
Facebook page addess, Twitter handle.
xs:string
Table A.30-1: CommunicationChannelType Example A.30-1: Communication Channel Example
A.31 ContactFlagsType
Contains Yes/No characteristics of the contact person's role with the student.
Figure A.31-1: ContactFlagsType
Table A.31-1: ContactFlagsType
A.32 ContactListType
A list of people's contact details
Figure A.32-1: ContactListType
Element/@Attribute Char Description Type ContactListType A list of people's contact details
List MR ContactType
Table A.32-1: ContactListType JSON {
"ContactList": {
"Contact": [
{
"Name": {
"FamilyName": "Dumbledore",
"GivenName": "Albus",
"FullName": "Albus Dumbledore"
},
"PositionTitle": "Headmaster",
"Role": "PRI",
"AddressList": {
"Address": [
{
"Type": "TH",
"Role": "PHY",
"Line1": "533 Hogwart's Way",
"City": "Hogsmead",
"PostalCode": "7733"
}
]
},
"EmailList": {},
"PhoneNumberList": {}
},
{
"Name": {
"FamilyName": "Rubeus",
"GivenName": "Hagrid",
"FullName": "Rubeud Hagrid"
},
"PositionTitle": "Gamekeeper",
"Role": "DIR",
"AddressList": {
"Address": [
{
"Type": "TH",
"Role": "PHY",
"Line1": "The Enchanted Wood",
"Line2": "533 Hogwart's Way",
"City": "Hogsmead",
"PostalCode": "7733"
}
]
},
"EmailList": {},
"PhoneNumberList": {}
}
]
}
}
Example A.32-1: Contact List Example
A.33 ContactType
A particular person's contact details
Figure A.33-1: ContactType
Table A.33-1: ContactType JSON {
"Contact": {
"Name": {
"FamilyName": "Dumbledore",
"GivenName": "Albus",
"FullName": "Albus Dumbledore"
},
"PositionTitle": "Head Cattle Wrangler",
"Role": "PRI",
"AddressList": {
"Address": [
{
"Type": "TH",
"Role": "PHY",
"Line1": "533 Hogwart's Way",
"City": "Hogsmead",
"PostalCode": "7733"
}
]
},
"EmailList": {},
"PhoneNumberList": {}
}
}
Example A.33-1: Contact Example
A.34 CountryListType
Figure A.34-1: CountryListType
Element/@Attribute Char Description Type CountryListType List MR A person's country of citizenship.
ISO3166CountryType
Table A.34-1: CountryListType
A.35 CourseListType
A list of associated courses.
Figure A.35-1: CourseListType
Element/@Attribute Char Description Type CourseListType A list of associated courses.
List MR An associated course. ObjectReferenceType
Table A.35-1: CourseListType
A.36 CredentialListType
A list of ObjectReferences providing a manner of referring
to a collection of Credentials.
Figure A.36-1: CredentialListType
Element/@Attribute Char Description Type CredentialListType A list of ObjectReferences providing a manner of referring
to a collection of Credentials.
List MR ObjectReferenceType
Table A.36-1: CredentialListType
A.37 DemographicsType
Demographics information about the student, contact, staff member, etc.
Figure A.37-1: DemographicsType
Element/@Attribute Char Description Type DemographicsType Demographics information about the student, contact, staff member, etc.
O The person's date of birth.
xs:date O The person's date of death.
xs:date O The person's place of birth - like village, town, city etc.
xs:normalizedString O The person's country of birth.
ISO3166CountryType O CountryListType O The Citizenship or Residency status of the Person
NZCodeSetsCitizenshipStatusType O
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.
VerificationEventType O The gender with which the Person identifies, according to
NZ Standard Gender Identity codes.
NZCodeSetsGenderType O List of languages an individual uses to communicate. LanguageListType O Date the person first arrived in the country. xs:date O One or more ethnic groups with which the person identifies.
EthnicityListType O A list of one or more iwi with which the person has an affiliation.
IwiAffiliationList O A list of one or more religions with which the person has an affiliation.
ReligiousAffiliationList
Table A.37-1: DemographicsType JSON {
"Demographics": {
"BirthDate": "1990-09-26",
"PlaceOfBirth": "Dunedin",
"CountryOfBirth": "ZAF",
"CitizenshipList": {
"Country": [
"NZL",
"ZAF"
]
},
"CitizenshipStatus": "NZCI",
"CitizenshipVerification": {
"Source": "NZPAS",
"DocumentSerialNumber": "L905673",
"DocumentExpiryDate": "2019-03-30",
"IsConfirmed": true,
"Timestamp": "2003-11-30T12:34:56.7",
"Provider": {
"RefId": "822f6c83-2841-4a87-9ff9-49730951b3ba"
}
},
"Gender": "2",
"LanguageList": {
"Language": [
{
"Code": "NZS01110",
"Usage": "FL"
},
{
"Code": "NZS01112",
"Usage": "SL"
}
]
},
"EthnicityList": {
"Ethnicity": [
{
"PreferenceOrderNumber": 1,
"Code": 111
},
{
"PreferenceOrderNumber": 1,
"Code": 211
}
]
},
"IwiAffiliationList": {
"Iwi": [
{
"Code": "NZS1001",
"PreferenceOrderNumber": 1,
"HapuAffiliationList": {
"Hapu": [
{
"HapuName": "Manukorihi",
"PreferenceOrderNumber": 1
}
]
}
}
]
},
"ReligiousAffiliationList": {
"ReligiousAffiliation": [
"NZS212",
"NZS215"
]
}
}
}
Example A.37-1: Demographics Example
A.38 DetentionContainerType
Container for details of a Detention.
Figure A.38-1: DetentionContainerType
Element/@Attribute Char Description Type DetentionContainerType Container for details of a Detention.
O Categorisation of a Detention.
NZCodeSetsDetentionCategoryType O The date of the detention.
xs:date O Eventually to be typed for initial draft will be string to try and determine a valid code set.
xs:string O Any notes that can be provided regarding the need/response that led to the detention.
xs:string
Table A.38-1: DetentionContainerType
A.39 DocumentListType
A list of documents relevent to the contents of the data object.
Figure A.39-1: DocumentListType
Element/@Attribute Char Description Type DocumentListType A list of documents relevent to the contents of the data object.
List MR The Document and it's meta-data, e.g. evidentiary documents, personalised plans, action plans.
ObjectReferenceType
Table A.39-1: DocumentListType
A.40 EarlyChildhoodEducationType
A summary of the early childhood education the student received before enrolling in their first school.
Figure A.40-1: EarlyChildhoodEducationType
Element/@Attribute Char Description Type EarlyChildhoodEducationType A summary of the early childhood education the student received before enrolling in their first school.
O The type of early childhood education the student received.
NZCodeSetsEarlyChildhoodEducationTypeType O The total number of hours of early childhood education attended, prior to enrolling in their first school.
xs:int
Table A.40-1: EarlyChildhoodEducationType
A.41 ECEEducationHistoryListType
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.
Figure A.41-1: ECEEducationHistoryListType
Element/@Attribute Char Description Type ECEEducationHistoryListType 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.
List MR The type of early childhood education the student received and the hours per week and/or day the student attended.
ECEHistoryType
Table A.41-1: ECEEducationHistoryListType
A.42 ECEHistoryType
History of a type of early childhood education the student received and
the hours per week and/or day the student attended.
Figure A.42-1: ECEHistoryType
Element/@Attribute Char Description Type ECEHistoryType History of a type of early childhood education the student received and
the hours per week and/or day the student attended.
O The type of early childhood education the student attended.
NZCodeSetsEarlyChildhoodEducationTypeType O The number of hours per day the student attended this ECE Type.
xs:int O The number of hours per week the student attended this ECE Type.
xs:int
Table A.42-1: ECEHistoryType
A.43 ECEServiceType
Contains Organisation properties that are specific to Organisations
that are Providers of early childhood education services.
Figure A.43-1: ECEServiceType
Element/@Attribute Char Description Type ECEServiceType Contains Organisation properties that are specific to Organisations
that are Providers of early childhood education services.
O Code denoting the kind of ECE service. eg: Kindergarten, PLayCentre, Te Kohanga Reo, etc.
NZCodeSetsECEServiceTypeType M The primary language utilised by the ECE Service.
NZCodeSetsLanguageType M Additional information about a language when one of the 'Other' language codes sets is selected.
xs:normalizedString
Table A.43-1: ECEServiceType
A.44 EduOrganisationType
Generic organisation that operates within the education sector.
For example Providers, Communities of Learning, Ministry local offices, etc.
Figure A.44-1: EduOrganisationType
Element/@Attribute Char Description Type EduOrganisationType Generic organisation that operates within the education sector.
For example Providers, Communities of Learning, Ministry local offices, etc.
O The set of postal and other addresses that the Organisation uses
AddressListType O A list of one or more methods of communication with the organisation
CommunicationChannelListType O A list of one or more cotact persons related to the organisation
ContactListType O A region of New Zealand defined by the Ministry of Education for adminstrative purposes
NZCodeSetsEducationRegionType O The special education district the provider belongs to.
NZCodeSetsSpecialEducationDistrictType O The set of contact email addresses that the Organisation uses
EmailListType O Closing date of entity. Only present for closed providers.
xs:date O Opening date of entity. For proposed schools this will
be the projected opening date. For open schools this may
not be present.
xs:date O A list of one or more locations, from which the
organisation operates or provides a service.
LocationListType M The normal business name of the Organisation
xs:normalizedString O The set of contact phone numbers that the Organisation uses
PhoneNumberListType O A list of other organisations that are related to the Provider
RelatedOrganisationListType O Current status of the Provider
NZCodeSetsOperationalStatusType O The reason the operational status of the organisation was changed.
NZCodeSetsOperationalStatusReasonType M Describes the nature of the Organisation; for Schools this indicate
the schooling levels offered.
NZCodeSetsOrganisationTypeType O Code denoting the role the organisation plays within the education sector,
e.g. School Sector Institution, Learning Support Cluster, etc.
NZCodeSetsOrganisationSectorRoleType O The name of the School Management System (SMS) that the provider is currently using. Note: not all education providers use an SMS.
NZCodeSetsSchoolManagementSystemType O Provides iinformation specific to Te Rito, e.g. which functionality in
Te Rito an organisation (school, ECE etc.) is utilising.
TeRitoConfigurationType O Indicates whether or not an ECE Service Provider Organisation is a Licenced ECE Service Provider.
NZCodeSetsYesOrNoCategoryType O Indicates whether or not an ECE Service Provider Organisation is a Playgroup Service Provider.
NZCodeSetsYesOrNoCategoryType O The type of ECE Service Provider ownership, e.g. Sole Trader,
Company, Charitable Trust etc.
NZCodeSetsECEServiceProviderOwnershipTypeType
Table A.44-1: EduOrganisationType
A.45 EmailListType
A list of e-mail addresses associated with an individual or organization.
Figure A.45-1: EmailListType
Element/@Attribute Char Description Type EmailListType A list of e-mail addresses associated with an individual or organization.
List MR EmailType
Table A.45-1: EmailListType Example A.45-1: Email List Example
A.46 EmailType
This element represents an e-mail address of one of a
number of types and occurs in objects such as
StudentPersonal, StaffPersonal,
StudentContactPersonal, etc.
Figure A.46-1: EmailType
Element/@Attribute Char Description Type EmailType
This element represents an e-mail address of one of a
number of types and occurs in objects such as
StudentPersonal, StaffPersonal,
StudentContactPersonal, etc.
Extension of BaseCommunicationChannelType O Notes on when / how to use the communication channel. eg: Phone after 4pm
xs:string O Preference number indicating an order in which communication channels should be used
when contacting person or organisation.
xs:unsignedInt O A code describing the acceptable usage of a person or organisation's communication channel
NZCodeSetsCommunicationUsageType O A Code denoting how the owner of the e-mail address describes it.
NZCodeSetsEmailTypeType O Generic object reference to the organisation that provided the email address.
OrganisationObjectReference M The actual email address.
xs:normalizedString
Table A.46-1: EmailType Example A.46-1: NZ Email Type Example
A.47 EnactedPolicyListType
A list of EnactedPolicy elements, describing the
state legislated policy choices the school has adopted, and the
time-period of that adoption.
Figure A.47-1: EnactedPolicyListType
Element/@Attribute Char Description Type EnactedPolicyListType A list of EnactedPolicy elements, describing the
state legislated policy choices the school has adopted, and the
time-period of that adoption.
List MR EnactedPolicyType
Table A.47-1: EnactedPolicyListType Example A.47-1: NZ Policy Choice List Example
A.48 EnactedPolicyType
A descriptor for a particular enacted policy that has been adopted by a school.
Figure A.48-1: EnactedPolicyType
Element/@Attribute Char Description Type EnactedPolicyType A descriptor for a particular enacted policy that has been adopted by a school.
O The date from which the school adopted the policy. If not populated
then this is the current/original policy of the school.
xs:date O 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.
xs:date M Which recognised policy has been chosen?
NZCodeSetsEnactedPolicyType
Table A.48-1: EnactedPolicyType
A.49 EthnicityListType
A list of one or more ethnic groups with which a person identifies.
Figure A.49-1: EthnicityListType
Element/@Attribute Char Description Type EthnicityListType A list of one or more ethnic groups with which a person identifies.
List MR EthnicityType
Table A.49-1: EthnicityListType Example A.49-1: Ethnicity List Example
A.50 EthnicityType
An ethnic group with which the person identifies, and if there is more than one, their order of preference.
Figure A.50-1: EthnicityType
Element/@Attribute Char Description Type EthnicityType An ethnic group with which the person identifies, and if there is more than one, their order of preference.
O The order of preference for the person's ethnicity.
xs:int M An ethnic group with which the person identifies.
NZCodeSetsEthnicityType
Table A.50-1: EthnicityType
A.51 EventLocationListType
A list of the locations where the incident took place.
Figure A.51-1: EventLocationListType
Element/@Attribute Char Description Type EventLocationListType A list of the locations where the incident took place.
List MR The location where the incident took place.
NZCodeSetsWellbeingEventLocationType
Table A.51-1: EventLocationListType
A.52 FollowUpActionListType
List of Actions where an action resulted and is known – maybe just a link to a WellbeingResponse Object
Figure A.52-1: FollowUpActionListType
Element/@Attribute Char Description Type FollowUpActionListType List of Actions where an action resulted and is known – maybe just a link to a WellbeingResponse Object
List MR Container for the Follow Up details. FollowUpActionType
Table A.52-1: FollowUpActionListType
A.53 FollowUpActionType
Repeatable Follow Up Action.
Figure A.53-1: FollowUpActionType
Element/@Attribute Char Description Type FollowUpActionType Repeatable Follow Up Action.
O The RefId of a WellbeingResponse Object if it exists.
IdRefType O Optional free text to outline follow up.
xs:string O Category of Action - typing locally defined.
xs:string
Table A.53-1: FollowUpActionType
A.54 GridLocationType
This element contains a map location. The GridLocation
element is utilized within the Address element.
Figure A.54-1: GridLocationType
Element/@Attribute Char Description Type GridLocationType This element contains a map location. The GridLocation
element is utilized within the Address element.
M Latitude in decimal degrees.
Latitudes north of the equator are positive, latitudes south of the equator are negative [ISO 6709] .
xs:decimal M 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]
xs:decimal
Table A.54-1: GridLocationType Example A.54-1: Grid Location Example
A.55 GUIDType
SIF format for a UUID; as defined in rfc-4122
Figure A.55-1: GUIDType
Element/@Attribute Char Description Type GUIDType SIF format for a UUID; as defined in rfc-4122
xs:token xs:pattern [a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}
Table A.55-1: GUIDType
A.56 HapuAffiliationListType
A list of one or more affiliations of a person with a Hapū within an Iwi.
Figure A.56-1: HapuAffiliationListType
Element/@Attribute Char Description Type HapuAffiliationListType A list of one or more affiliations of a person with a Hapū within an Iwi.
List MR A Hapū a person is affiliated with.
HapuType
Table A.56-1: HapuAffiliationListType Example A.56-1: Hapu List Example
A.57 HapuType
An hapu the person is affiliated to.
Figure A.57-1: HapuType
Element/@Attribute Char Description Type HapuType An hapu the person is affiliated to.
M The name of a Hapū that the person is affiliated with.
xs:normalizedString O 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'.
xs:int
Table A.57-1: HapuType Example A.57-1: Hapu Example
A.58 HealthcareServiceInfoType
Details of a healthcare service provided by the student contact, for example if the contact is a doctor or dentist.
Figure A.58-1: HealthcareServiceInfoType
Element/@Attribute Char Description Type HealthcareServiceInfoType Details of a healthcare service provided by the student contact, for example if the contact is a doctor or dentist.
M The name of the healthcare service, eg: 'Martinborough Health Centre'
xs:normalizedString M The name phone number of the healthcare service
xs:normalizedString O Who at the healthservice is the Student's regular e.g. 'Dr Phillips'
xs:normalizedString M What kind of healthcare service is provided to the Student by the contact?
NZCodeSetsHealthcareServiceTypeType
Table A.58-1: HealthcareServiceInfoType Example A.58-1: Healthcare Service Info Example
A.59 HouseholdContactInfoListType List of Households this Person is associated with
Figure A.59-1: HouseholdContactInfoListType
Element/@Attribute Char Description Type HouseholdContactInfoListType List of Households this Person is associated with List MR Common element used to supply information about a particular household a person is a member of. HouseholdContactInfoType
Table A.59-1: HouseholdContactInfoListType
A.60 HouseholdContactInfoType
Common element used to supply information about a particular household a person is a member of.
Figure A.60-1: HouseholdContactInfoType
Element/@Attribute Char Description Type HouseholdContactInfoType Common element used to supply information about a particular household a person is a member of.
O Priority of Household Contact in relation to this Person.
xs:unsignedInt O Local Household Id
LocalIdType O Salutation to be used in addressing this household.
xs:normalizedString O
AddressListType O List of Email elements.
EmailListType O List of PhoneNumber elements.
PhoneNumberListType
Table A.60-1: HouseholdContactInfoType JSON {
"HouseholdContactInfo": {
"PreferenceNumber": 1,
"HouseholdContactId": "7d5c3f5c-d89c-4551-9442-6b008207986e",
"AddressList": {
"Address": [
{
"Type": "DE",
"Role": "POS",
"Line1": "P O Box 81",
"City": "Martinborough",
"PostalCode": "5781"
}
]
},
"EmailList": {
"Email": [
{
"Type": "WORK",
"Address": "hagrid@gmail.com"
}
]
},
"PhoneNumberList": {
"PhoneNumber": [
{
"Usage": "INT",
"Type": "MAI",
"Number": "(021) 300 999"
}
]
}
}
}
Example A.60-1: Household Contact Info Example
A.61 HouseholdListType
A list of HouseholdContactIds, from the Student's HouseholdContactInfoList
that the StudentContact is also a member of.
Figure A.61-1: HouseholdListType
Element/@Attribute Char Description Type HouseholdListType A list of HouseholdContactIds, from the Student's HouseholdContactInfoList
that the StudentContact is also a member of.
List MR Repeatable element containing the HouseholdContactId of a household identifier from
the Student's HouseholdContactInfoList, that the StudentContact is also a member of.
LocalIdType
Table A.61-1: HouseholdListType
A.62 IdRefType A reference to a RefId.
Figure A.62-1: IdRefType
Element/@Attribute Char Description Type IdRefType A reference to a RefId. RefIdType
Table A.62-1: IdRefType
A.63 InternationalSchoolEnrolmentType
Additional information collected for international enrolments.
Figure A.63-1: InternationalSchoolEnrolmentType
Element/@Attribute Char Description Type InternationalSchoolEnrolmentType O Additional information collected for international enrolments.
O The date the Student arrived in New Zealand.
xs:date O The amount paid by the Student per Week (GST excl) as a tuition fee.
xs:decimal O Which government approved exchange scheme is the student part of?
NZCodeSetsExchangeSchemeType
Table A.63-1: InternationalSchoolEnrolmentType Example A.63-1: International School Enrolment
A.64 InterventionListType
A list of references to Wellbeing Event, Response & Appeal data objects,
that record the process of terminating a students enrolment.
Figure A.64-1: InterventionListType
Element/@Attribute Char Description Type InterventionListType A list of references to Wellbeing Event, Response & Appeal data objects,
that record the process of terminating a students enrolment.
List MR A reference to a Wellbeing Event, Response & Appeal data object,
that records the process of terminating a students enrolment.
ObjectReferenceType
Table A.64-1: InterventionListType
A.65 IwiAffiliationListType
A list of one or more Iwi with which a person affiliates.
Figure A.65-1: IwiAffiliationListType
Element/@Attribute Char Description Type IwiAffiliationListType A list of one or more Iwi with which a person affiliates.
List MR An iwi the person is associated to.
IwiType
Table A.65-1: IwiAffiliationListType Example A.65-1: Iwi List Example
A.66 IwiType
An iwi the person is affiliated to.
Figure A.66-1: IwiType
Element/@Attribute Char Description Type IwiType An iwi the person is affiliated to.
M The code of the iwi the person is affiliated to.
NZCodeSetsIwiType O 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'.
xs:int O A list of one or more affiliations of a person with a Hapū within an Iwi.
HapuAffiliationListType
Table A.66-1: IwiType Example A.66-1: Iwi Example
A.67 JustificationListType
A list identifying the assessment task results that justify the student
achieving this attainment.
Figure A.67-1: JustificationListType
Element/@Attribute Char Description Type JustificationListType A list identifying the assessment task results that justify the student
achieving this attainment.
List MR A generic reference to an assessment task result or other student attainment
that justifies the student achieving this attainment.
JustificationType
Table A.67-1: JustificationListType JSON {
"JustificationList": {
"Justification": [
{
"RefId": "2752a16b-b62a-4973-9d44-23e13e1c037b",
"LocalId": "91165-v2",
"Name": "Demonstrate understanding of the properties of selected organic compounds",
"ObjectType": "StudentAssessmentTaskResult",
"AssessmentType": "EXT",
"Result": "Achieved",
"Date": "2016-06-28",
"CreditValue": 4
},
{
"RefId": "eca0da5d-94af-4223-aaa6-7c0083006efd",
"LocalId": "91166-v2",
"Name": "Demonstrate understanding of chemical reactivity",
"ObjectType": "StudentAssessmentTaskResult",
"AssessmentType": "INT",
"Result": "Achieved with merit",
"Date": "2016-06-01",
"CreditValue": 3
},
{
"RefId": "12f4761d-5e97-4e12-804e-e16d882c86c7",
"LocalId": "91167-v2",
"Name": "Demonstrate understanding of oxidation-reduction",
"ObjectType": "StudentAssessmentTaskResult",
"AssessmentType": "EXT",
"Result": "Achieved",
"Date": "2016-06-01",
"CreditValue": 3
}
]
}
}
Example A.67-1: Multiple Unit Standards Justification List
A.68 JustificationType
Details of an assessment task result or other student attainment that
justifies the student achieving this attainment.
Figure A.68-1: JustificationType
Element/@Attribute Char Description Type JustificationType Details of an assessment task result or other student attainment that
justifies the student achieving this attainment.
Extension of ObjectReferenceType O The GUUID of the referenced object
IdRefType O Local identifier representing the referenced object.
LocalIdType O The normal descriptive name of the referenced object.
xs:string O The type of the referenced object:
NZCodeSetsReferrableDataObjectsType O A Code denoting how the Justification assessment task was assessed
NZCodeSetsAssessmentTypeType M The final result of the assessment task that justifies the attainment.
xs:normalizedString M The date the justifying assessment task was achieved.
xs:date O The number of credits the justifying assessment task contributes towards this attainment.
xs:decimal
Table A.68-1: JustificationType Example A.68-1: Justification Example
A.69 KeyContactListType
A list of key contacts for the alert.
Figure A.69-1: KeyContactListType
Element/@Attribute Char Description Type KeyContactListType A list of key contacts for the alert.
List MR KeyContactType
Table A.69-1: KeyContactListType
A.70 KeyContactType
A key contact for the Wellbeing Alert and their role, e.g. Parent, Doctor, Principal.
Figure A.70-1: KeyContactType
Element/@Attribute Char Description Type KeyContactType A key contact for the Wellbeing Alert and their role, e.g. Parent, Doctor, Principal.
O The role of the key contact in relation to the Wellbeing Alert.
NZCodeSetsKeyContactRoleType O Details about the contact, e.g. Doctor, Parent, Principal.
ObjectReferenceType
Table A.70-1: KeyContactType
A.71 LanguageBaseType
A language that an individual uses to communicate.
Figure A.71-1: LanguageBaseType
Element/@Attribute Char Description Type LanguageBaseType A language that an individual uses to communicate.
M The code representing the specific language that an individual uses to communicate.�
NZCodeSetsLanguageType O The usage of the language by a person, potentially
indicating capability and preference for the language.
NZCodeSetsLanguageUsageType O Specific dialect of a person's language.
xs:normalizedString O A list of the person's proficiency in the language in regards to speaking, reading and writing.
LanguageProficiencyListType
Table A.71-1: LanguageBaseType
A.72 LanguageListType
A list of languages that an individual uses to communicate
Figure A.72-1: LanguageListType
Element/@Attribute Char Description Type LanguageListType A list of languages that an individual uses to communicate
List MR LanguageBaseType
Table A.72-1: LanguageListType Example A.72-1: Language List Example
A.73 LanguageOfInstructionListType
Records the number of hours per week the Learner is taught in each language.
Figure A.73-1: LanguageOfInstructionListType
Element/@Attribute Char Description Type LanguageOfInstructionListType Records the number of hours per week the Learner is taught in each language.
List MR The number of hours per week the Learner is taught in a specific language during the enrolment.
LanguageOfInstructionType
Table A.73-1: LanguageOfInstructionListType Example A.73-1: LanguageOfInstructionList Example
A.74 LanguageOfInstructionType
The number of hours per week the Learner is taught in a specific language during the enrolment.
Figure A.74-1: LanguageOfInstructionType
Element/@Attribute Char Description Type LanguageOfInstructionType The number of hours per week the Learner is taught in a specific language during the enrolment.
M Code denoting the actual language of instruction.
NZCodeSetsLanguageType M The level of instruction that is made in the selected language.
NZCodeSetsLanguageInstructionLevelType
Table A.74-1: LanguageOfInstructionType Example A.74-1: LanguageOfInstruction Example
A.75 LanguageProficiencyListType
The person's proficiency in the language in regards to speaking, reading and writing.
Figure A.75-1: LanguageProficiencyListType
Element/@Attribute Char Description Type LanguageProficiencyListType The person's proficiency in the language in regards to speaking, reading and writing.
List MR The person's proficiency in the language in regards to speaking, reading and writing.
LanguageProficiencyType
Table A.75-1: LanguageProficiencyListType
A.76 LanguageProficiencyType
The person's proficiency in the language in regards to speaking, reading and writing.
Figure A.76-1: LanguageProficiencyType
Element/@Attribute Char Description Type LanguageProficiencyType The person's proficiency in the language in regards to speaking, reading and writing.
M The person's proficency level in the language in regards to reading, writing or speaking.
NZCodeSetsLanguageProficiencyLevelType M The type of language proficency, e.g. speaking, writing or reading.
NZCodeSetsLanguageProficiencyTypeType
Table A.76-1: LanguageProficiencyType
A.77 LearningStandardListType
A list of LearningStandardRefIds providing a manner of referring
to a collection of LearningStandards.
Figure A.77-1: LearningStandardListType
Element/@Attribute Char Description Type LearningStandardListType A list of LearningStandardRefIds providing a manner of referring
to a collection of LearningStandards.
List MR LocalIdType
Table A.77-1: LearningStandardListType
A.78 LearningStandardObjectReferenceType
A reference to a LearningStandard via Number and VersionNum
Figure A.78-1: LearningStandardObjectReferenceType
Element/@Attribute Char Description Type LearningStandardObjectReferenceType A reference to a LearningStandard via Number and VersionNum
M A unique number that is used to identify the learning standard. One use of this is for NZQA standard numbers
which cannot be used as a unique identifier (in LocalId) on their own as they are versioned so are part of
a composite key with VersionNo.
xs:int M The version of the learning standard.
xs:decimal
Table A.78-1: LearningStandardObjectReferenceType Example A.78-1: LearningStandardObjectReferenceType Example
A.79 LocalIdType
This is a common element used to define the locally assigned identifier
associated with an entity.
Figure A.79-1: LocalIdType
Element/@Attribute Char Description Type LocalIdType
This is a common element used to define the locally assigned identifier
associated with an entity.
xs:normalizedString
Table A.79-1: LocalIdType Example A.79-1: LocalId Example
A.80 LocationListType
A list of Location elements.
Figure A.80-1: LocationListType
Element/@Attribute Char Description Type LocationListType A list of Location elements.
List MR LocationType
Table A.80-1: LocationListType JSON {
"LocationList": {
"Location": [
{
"Description": "Junior Campus",
"Address": {
"Type": "TH",
"Role": "PHY",
"Line1": "1175 Lake Ferry Rd",
"Suburb": "RD 1",
"City": "Martinborough",
"PostalCode": "5781"
},
"GridLocation": {
"Latitude": -41.2814719,
"Longitude": 175.3458472
},
"StatisticalAreaList": {
"StatisticalArea": [
{
"SpatialUnitType": "GE",
"Code": "058"
},
{
"SpatialUnitType": "TA",
"Code": "050"
},
{
"SpatialUnitType": "WA",
"Code": "05003"
}
]
}
}
]
}
}
Example A.80-1: Location List Example
A.81 LocationType
This element contains data about a geographical location
Figure A.81-1: LocationType
Element/@Attribute Char Description Type LocationType This element contains data about a geographical location.
O A description for the Location.
xs:string O Number identifying the individual location within the set of locations used by the Provider.
xs:int O The physical address of the Location
AddressType O 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)
GridLocationType O A list of Statistical Areas containing the location.
The list may contain exactly one StatisticalArea
element for each of the following spatial unit types:
Ward Urban Area Census Area Unit Māori Electorate Mesh Block General Electorate Territorial Authority Local Board (Auckland Only) Regional Council StatisticalAreaListType
Table A.81-1: LocationType JSON {
"Location": {
"Description": "Junior Campus",
"Address": {
"Type": "TH",
"Role": "PHY",
"Line1": "1175 Lake Ferry Rd",
"Suburb": "RD 1",
"City": "Martinborough",
"Country": "New Zealand",
"PostalCode": "5781"
},
"GridLocation": {
"Latitude": 41.85,
"Longitude": -87.65
},
"StatisticalAreaList": {
"StatisticalArea": [
{
"SpatialUnitType": "GE",
"Code": "058"
},
{
"SpatialUnitType": "TA",
"Code": "050"
},
{
"SpatialUnitType": "WA",
"Code": "05003"
}
]
}
}
}
Example A.81-1: Location Example
A.82 MedicalNeedListType
A list of a persons known medical needs.
Figure A.82-1: MedicalNeedListType
Element/@Attribute Char Description Type MedicalNeedListType A list of a persons known medical needs.
List MR A persons known medical need.
ObjectReferenceType
Table A.82-1: MedicalNeedListType
A.83 MedicationConsentListType
A list consents that have been provided for administration of a medicine to a student.
Figure A.83-1: MedicationConsentListType
Element/@Attribute Char Description Type MedicationConsentListType A list consents that have been provided for administration of a medicine to a student.
List MR MedicationConsentType
Table A.83-1: MedicationConsentListType
A.84 MedicationConsentType
Contains information about when, by whom, and who consent was given to for the administration of a medicine to a student.
Figure A.84-1: MedicationConsentType
Element/@Attribute Char Description Type MedicationConsentType Contains information about when, by whom, and who consent was given to for the administration of a medicine to a student.
M The date from which the student or student caretaker consented to the medicine being administered to the student by a particular individual.
xs:date O The date the consent for administration of the medicine ends or is revoked.
xs:date M The student or student caregiver that has consented to the medicine being administered to the student by the school.
ObjectReferenceType O The provider the medication administartion consent is applicable to.
ObjectReferenceType O 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.
ObjectReferenceType
Table A.84-1: MedicationConsentType
A.85 MedicationListType
A list of the medications required for this Wellbeing Characteristic.
Figure A.85-1: MedicationListType
Element/@Attribute Char Description Type MedicationListType A list of the medications required for this Wellbeing Characteristic.
List MR MedicationType
Table A.85-1: MedicationListType
A.86 MedicationType
The medication, dosage and frequency, required by the student to manage the Wellbeing Characteristic.
Figure A.86-1: MedicationType
Element/@Attribute Char Description Type MedicationType The medication, dosage and frequency, required by the student to manage the Wellbeing Characteristic.
O Name of medication required for the student.
xs:string O Dosage and strength of medication required for the student.
xs:string O Frequency of Administration.
xs:string O Information about how the medication is to be administered.
xs:string O Method of administration.
xs:string O MedicationConsentListType
Table A.86-1: MedicationType
A.87 MoEOrgIdType 1 to 5 digit Ministry Organisation Id, without leading zeros
Figure A.87-1: MoEOrgIdType
Element/@Attribute Char Description Type MoEOrgIdType 1 to 5 digit Ministry Organisation Id, without leading zeros xs:token
Table A.87-1: MoEOrgIdType
A.88 NoteListType
A list of notes that have been written about the associated subject matter.
Figure A.88-1: NoteListType
Element/@Attribute Char Description Type NoteListType A list of notes that have been written about the associated subject matter.
List MR A free text note about the associated subject matter.
NoteType
Table A.88-1: NoteListType
A.89 NoteType
A free text note about the associated subject matter.
Figure A.89-1: NoteType
Element/@Attribute Char Description Type NoteType A free text note about the associated subject matter.
M Free text note.
xs:normalizedString M The date and time the note was created.
xs:dateTime O The date and time the note was last updated.
xs:dateTime M Generic reference to the user that created the note.
ObjectReferenceType O Generic reference to the user that last updated the note.
ObjectReferenceType
Table A.89-1: NoteType
A.90 NZQAAssessmentRegistrationType
Extra details to support NZQA assessment registration process
Figure A.90-1: NZQAAssessmentRegistrationType
Table A.90-1: NZQAAssessmentRegistrationType
A.91 NZQAEnrolmentType NZQA details for a student for this school year.
Figure A.91-1: NZQAEnrolmentType
Element/@Attribute Char Description Type NZQAEnrolmentType NZQA details for a student for this school year. O The student's NZQA enrolment Id.
xs:normalizedString O Amount paid by student to school for current year's NZQA fees.
xs:decimal O Code set denoting the type of financial assistance the student is receiving.
NZCodeSetsNZQAFinancialAssistanceType O Student’s NZQA sort code, e.g. 13AB. Sort order for admission slips.
Often the form class of the student.
xs:normalizedString O Full name of person submitting student information to NZQA.
xs:normalizedString O E-mail address of person submitting student information to NZQA.
xs:normalizedString O Indicates that the student has withdrawn from all NZQA assessments.
NZCodeSetsYesOrNoCategoryType
Table A.91-1: NZQAEnrolmentType
A.92 ObjectReferenceType
A reference to another SIF Data Object
Figure A.92-1: ObjectReferenceType
Element/@Attribute Char Description Type ObjectReferenceType A reference to another SIF Data Object
ObjectReferenceType is the base type for the following data types: O The GUUID of the referenced object
IdRefType O Local identifier representing the referenced object.
LocalIdType O The normal descriptive name of the referenced object.
xs:string O The type of the referenced object:
NZCodeSetsReferrableDataObjectsType
Table A.92-1: ObjectReferenceType Example A.92-1: ObjectReferenceType Example
A.93 OfficialDiagnosisListType
A list of official diagnoses that pertains to this wellbeing characteristic.
Figure A.93-1: OfficialDiagnosisListType
Element/@Attribute Char Description Type OfficialDiagnosisListType A list of official diagnoses that pertains to this wellbeing characteristic.
List MR An official diagnosis that pertains to this Wellbeing Characteristic.
OfficialDiagnosisType
Table A.93-1: OfficialDiagnosisListType
A.94 OfficialDiagnosisType
An official diagnosis that pertains to this Wellbeing Characteristic.
Figure A.94-1: OfficialDiagnosisType
Element/@Attribute Char Description Type OfficialDiagnosisType An official diagnosis that pertains to this Wellbeing Characteristic.
M The official diagnosis type the student was given.
NZCodeSetsOfficialDiagnosisTypeType O The official diagnosis sub-type the student was given.
NZCodeSetsOfficialDiagnosisSubTypeType O 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’.
xs:normalizedString O A list of documents that conatin information that pertain to this official diagnosis.
DocumentListType
Table A.94-1: OfficialDiagnosisType
A.95 OrganisationObjectReferenceType
A reference to a Provider specific location at the Organisation; rather
than the Provider as a whole.
Figure A.95-1: OrganisationObjectReferenceType
Element/@Attribute Char Description Type OrganisationObjectReferenceType A reference to a Provider specific location at the Organisation; rather
than the Provider as a whole.
Extension of ProviderObjectReferenceType M The Ministry of Education Organisation Id of the referenced provider
MoEOrgIdType O The normal descriptive name of the referenced object.
xs:string O Number identifying the individual location within the set of locations used by the Provider.
xs:int
Table A.95-1: OrganisationObjectReferenceType Example A.95-1: LocationObjectReferenceType Example
A.96 OtherNameListType
Previous, alternate or other names or aliases associated with a person.
Figure A.96-1: OtherNameListType
Element/@Attribute Char Description Type OtherNameListType O Previous, alternate or other names or aliases associated with a person.
List MR Name of the person. Note: Type value of LGL may not occur here.
VerifiedNameType
Table A.96-1: OtherNameListType JSON {
"OtherNameList": {
"Name": [
{
"FamilyName": "Anderson",
"GivenName": "Samuel",
"FullName": "Samuel Anderson",
"Type": "AKA",
"IsVerified": "N"
},
{
"FamilyName": "Rowinski",
"GivenName": "Sam",
"FullName": "Sam Rowinski ",
"Type": "PRF",
"IsVerified": "Y",
"Verification": {
"Source": "NZPAS",
"DocumentSerialNumber": "L905673",
"DocumentExpiryDate": "2019-03-30",
"IsConfirmed": true,
"Timestamp": "2003-11-30T12:34:56.7",
"Provider": {
"RefId": "822f6c83-2841-4a87-9ff9-49730951b3ba"
}
}
}
]
}
}
Example A.96-1: Other Names Example
A.97 OtherWellbeingResponseContainerType
Container for details of any other response that can not be classified by previous types.
Figure A.97-1: OtherWellbeingResponseContainerType
Element/@Attribute Char Description Type OtherWellbeingResponseContainerType Container for details of any other response that can not be classified by previous types.
O Date of the other response
xs:date O Description of the other response.
xs:string O Any comments/notes associated with the other response.
xs:string
Table A.97-1: OtherWellbeingResponseContainerType
A.98 PeriodListType
A list of the object references to a set of SchedulePeriods
Figure A.98-1: PeriodListType
Element/@Attribute Char Description Type PeriodListType A list of the object references to a set of SchedulePeriods
List MR A generic object references to a SchedulePeriod in the list
ObjectReferenceType
Table A.98-1: PeriodListType Example A.98-1: PeriodList List Example
A.99 PersonDocumentRoleListType
The list of people associated to a document and their role in relation to it,
e.g. author, owner, reviewer, subject of.
Figure A.99-1: PersonDocumentRoleListType
Element/@Attribute Char Description Type PersonDocumentRoleListType The list of people associated to a document and their role in relation to it,
e.g. author, owner, reviewer, subject of.
List MR A person associated to a document and their role in relation to it,
e.g. author, owner, reviewer, subject of.
PersonDocumentRoleType
Table A.99-1: PersonDocumentRoleListType
A.100 PersonDocumentRoleType
A person associated to a document and their role in
relation to it, e.g. author, owner, reviewer, subject of.
Figure A.100-1: PersonDocumentRoleType
Element/@Attribute Char Description Type PersonDocumentRoleType A person associated to a document and their role in
relation to it, e.g. author, owner, reviewer, subject of.
O 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.
NZCodeSetsDocumentRoleType O A non student person associated to a document and their role in relation to it, e.g. author, owner, reviewer, subject of.
ObjectReferenceType O A student associated to a document and their role in relation to it, e.g. author, owner, reviewer, subject of.
StudentObjectReferenceType
Table A.100-1: PersonDocumentRoleType
A.101 PersonInfoType
The personal information collected about students.
Figure A.101-1: PersonInfoType
Element/@Attribute Char Description Type PersonInfoType The personal information collected about students.
M A name used by the person
BaseNameType O Previous, alternate or other names or aliases
associated with the person.
OtherNameListType O The verified name of the person.
VerifiedNameType O Details of the person’s demographic properties
DemographicsType O The person's address(es) - one or more addresses AddressListType O The person's e-mail address(es) - one or more emails.
EmailListType O The person's phone number(s) - one or more phone numbers.
PhoneNumberListType O The person's household/s contact information. A list of
one or more household’s contact information.
HouseholdContactInfoListType O A photo of the person. A person photo is stored in Document against the student with a document type of Person Photo.
ObjectReferenceType O A list of a persons known medical needs.
MedicalNeedListType
Table A.101-1: PersonInfoType JSON {
"PersonInfo": {
"Name": {
"FamilyName": "Rubeus",
"GivenName": "Hagrid",
"FullName": "Rubeus Hagrid",
"Type": "LGL",
"IsVerified": "N"
},
"OtherNameList": {
"Name": [
{
"FamilyName": "Anderson",
"GivenName": "Samuel",
"FullName": "Samuel Anderson",
"Type": "AKA",
"Verification": {
"Source": "NZBIR",
"DocumentSerialNumber": "L905673",
"DocumentExpiryDate": "2019-03-30",
"IsConfirmed": true,
"Timestamp": "2003-11-30T12:34:56.7",
"Provider": {
"RefId": "822f6c83-2841-4a87-9ff9-49730951b3ba"
}
}
},
{
"FamilyName": "Rowinski",
"GivenName": "Sam",
"FullName": "Sam Rowinski ",
"Type": "PRF"
}
]
},
"Demographics": {
"BirthDate": "1990-09-26",
"PlaceOfBirth": "Dunedin",
"CountryOfBirth": "ZAF",
"CitizenshipList": {
"Country": [
"NZL",
"ZAF"
]
},
"CitizenshipStatus": "NZCI",
"CitizenshipVerification": {
"Source": "NZBIR",
"DocumentSerialNumber": "L905673",
"DocumentExpiryDate": "2019-03-30",
"IsConfirmed": true,
"Timestamp": "2003-11-30T12:34:56.7",
"Provider": {
"RefId": "822f6c83-2841-4a87-9ff9-49730951b3ba"
}
},
"Gender": 2,
"LanguageList": {
"Language": [
{
"Code": "NZS01110",
"Usage": "FL",
"ProficiencyList": {
"Proficiency": [
{
"Level": "AD",
"Type": "SP"
}
]
}
},
{
"Code": "NZS01112",
"Usage": "SL",
"ProficiencyList": {
"Proficiency": [
{
"Level": "BE",
"Type": "RE"
}
]
}
}
]
},
"EthnicityList": {
"Ethnicity": [
{
"PreferenceOrderNumber": 1,
"Code": 111
},
{
"PreferenceOrderNumber": 1,
"Code": 211
}
]
},
"IwiAffiliationList": {
"Iwi": [
{
"Code": "NZS1001",
"PreferenceOrderNumber": 1,
"HapuAffiliationList": {
"Hapu": [
{
"HapuName": "Manukorihi",
"PreferenceOrderNumber": 1
}
]
}
}
]
},
"ReligiousAffiliationList": {
"ReligiousAffiliation": [
"NZS212",
"NZS215"
]
}
},
"AddressList": {
"Address": [
{
"Type": "TH",
"Role": "PHY",
"Line1": "The Enchanted Wood",
"Line2": "533 Hogwart's Way",
"City": "Hogsmead",
"PostalCode": "7733"
},
{
"Type": "TH",
"Role": "PHY",
"Line1": "1175 Lake Ferry Rd",
"Suburb": "RD 1",
"City": "Martinborough"
}
]
},
"EmailList": {
"Email": [
{
"Type": "PRIM",
"Address": "hagrid@gmail.com"
}
]
},
"PhoneNumberList": {
"PhoneNumber": [
{
"Type": "MOB",
"Number": "(021) 300 999"
}
]
},
"HouseholdContactInfoList": {
"HouseholdContactInfo": [
{
"PreferenceNumber": 1,
"HouseholdContactId": "7d5c3f5c-d89c-4551-9442-6b008207986e",
"AddressList": {
"Address": [
{
"Type": "DE",
"Role": "POS",
"Line1": "P O Box 81",
"City": "Martinborough",
"PostalCode": "5781"
}
]
},
"EmailList": {
"Email": [
{
"Type": "PRIM",
"Address": "hagrid@gmail.com"
}
]
},
"PhoneNumberList": {
"PhoneNumber": [
{
"Usage": "INT",
"Type": "MAI",
"Number": "(021) 300 999"
}
]
}
}
]
}
}
}
Example A.101-1: PersonInfo Example
A.102 PersonInvolvementListType
List of People involved in the Wellbeing event/response. Mandatory if more people than the student to which this event/response occurs is involved.
Figure A.102-1: PersonInvolvementListType
Element/@Attribute Char Description Type PersonInvolvementListType List of People involved in the Wellbeing event/response. Mandatory if more people than the student to which this event/response occurs is involved.
List MR A person (additional to the student) involved in a Wellbeing event/response where required to be known. PersonInvolvementType
Table A.102-1: PersonInvolvementListType
A.103 PersonInvolvementType
A repeatable element recording the identifier and details of another person that was involved in the Wellbeing Event/Response.
Figure A.103-1: PersonInvolvementType
Table A.103-1: PersonInvolvementType
A.104 PhoneNumberListType
Lists phone numbers associated with an entity.
Figure A.104-1: PhoneNumberListType
Element/@Attribute Char Description Type PhoneNumberListType Lists phone numbers associated with an entity.
List MR PhoneNumberType
Table A.104-1: PhoneNumberListType Example A.104-1: Phone Number List Example
A.105 PhoneNumberType
This element represents a phone number and occurs within
objects such as StudentPersonal, StaffPersonal, etc.
Figure A.105-1: PhoneNumberType
Element/@Attribute Char Description Type PhoneNumberType This element represents a phone number and occurs within
objects such as StudentPersonal, StaffPersonal, etc.
Extension of BaseCommunicationChannelType O Notes on when / how to use the communication channel. eg: Phone after 4pm
xs:string O Preference number indicating an order in which communication channels should be used
when contacting person or organisation.
xs:unsignedInt O A code describing the acceptable usage of a person or organisation's communication channel
NZCodeSetsCommunicationUsageType O Code that specifies what type of phone number this is.
Note: A subset of valid values may be specified in data
objects.
NZCodeSetsTelephoneNumberTypeType M Phone number. Free-form, but typical New Zealand formats include:
(0##) ###-#### ###-#### +##### ### #### xs:normalizedString O Phone number extension.
xs:normalizedString O Indicates whether or not the phone number is available to the public.
NZCodeSetsYesOrNoCategoryType
Table A.105-1: PhoneNumberType Example A.105-1: Phone Number Example
A.106 PlanRequiredListType
List to contain information of any plans that may eventuate.
Figure A.106-1: PlanRequiredListType
Element/@Attribute Char Description Type PlanRequiredListType List to contain information of any plans that may eventuate.
List MR WellbeingPlanType
Table A.106-1: PlanRequiredListType
A.107 PossibleMotivationListType
A list of the possible motivations that triggered the event.
Figure A.107-1: PossibleMotivationListType
Table A.107-1: PossibleMotivationListType
A.108 PotentialDestinationSchoolListType
List of references to potential destination schools for the departing student.
Figure A.108-1: PotentialDestinationSchoolListType
Element/@Attribute Char Description Type PotentialDestinationSchoolListType List of references to potential destination schools for the departing student.
List MR A reference to a potential destination school for the departing student.
OrganisationObjectReferenceType
Table A.108-1: PotentialDestinationSchoolListType
A.109 PreEnrolmentCancellationType
Details around why a pre-enrolment for a school was cancelled.
Figure A.109-1: PreEnrolmentCancellationType
Element/@Attribute Char Description Type PreEnrolmentCancellationType Details around why a pre-enrolment for a school was cancelled.
O The date the Student was notified of the cancellation of the pre-enrolment.
xs:date O A code describing how the student's pre-enrolment was terminated.
NZCodeSetsPreEnrolmentExitTypeType O The reason the pre-enrolment was cancelled
NZCodeSetsPreEnrolmentCancellationReasonType O Free text reason the pre-enrolment was cancelled if the cancellation reason of other was selected.
xs:normalizedString
Table A.109-1: PreEnrolmentCancellationType
A.110 PrerequisiteListType
References to ProviderCourses, LearningStandards, Credentials, or AssessmentTasks that
the student must have completed or passed to engage in futher courses,
activities and assessment tasks.
Figure A.110-1: PrerequisiteListType
Element/@Attribute Char Description Type PrerequisiteListType References to ProviderCourses, LearningStandards, Credentials, or AssessmentTasks that
the student must have completed or passed to engage in futher courses,
activities and assessment tasks.
List MR A reference to a ProviderCourse, LearningStandard, Credential, or AssessmentTask that
the student must have completed or passed to engage in futher courses,
activities and assessment tasks.
ObjectReferenceType
Table A.110-1: PrerequisiteListType
A.111 ProgressReportAuthorListType
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.
Figure A.111-1: ProgressReportAuthorListType
Element/@Attribute Char Description Type ProgressReportAuthorListType 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.
List MR A generic object reference to a staff memberthat authored the progress report.
ObjectReferenceType
Table A.111-1: ProgressReportAuthorListType
A.112 ProviderExitType
Details of the reasons, and interventions leading up to the
student's enrolment being terminated.
Figure A.112-1: ProviderExitType
Element/@Attribute Char Description Type ProviderExitType Details of the reasons, and interventions leading up to the
student's enrolment being terminated.
M A code describing how or why the student's enrolment was terminated.
NZCodeSetsEnrolmentExitTypeType O The post school activity the student is moving on to once they have exited the school.
NZCodeSetsPostSchoolActivityType O A list of references to Wellbeing Event, Response & Appeal data objects,
that record the process of terminating a students enrolment.
InterventionListType O List of potential destination schools for the departing student.
PotentialDestinationSchoolListType
Table A.112-1: ProviderExitType
A.113 ProviderInvolvedListType
A list of the providers involved and their role,
e.g. assessing provider, assessment provider, assessment location provider, registering provider.
Figure A.113-1: ProviderInvolvedListType
Element/@Attribute Char Description Type ProviderInvolvedListType A list of the providers involved and their role,
e.g. assessing provider, assessment provider, assessment location provider, registering provider.
List MR The provider involved with the assessment task and the role they play,
e.g. assessing provider, assessment location provider, assessment provider, registering provider.
ProviderInvolvedType
Table A.113-1: ProviderInvolvedListType
A.114 ProviderInvolvedType
The provider and Location with the assessment task and the role they play,
e.g. assessing provider, assessment location provider, assessment provider, registering provider.
Figure A.114-1: ProviderInvolvedType
Element/@Attribute Char Description Type ProviderInvolvedType The provider and Location with the assessment task and the role they play,
e.g. assessing provider, assessment location provider, assessment provider, registering provider.
Extension of ProviderObjectReferenceType M The Ministry of Education Organisation Id of the referenced provider
MoEOrgIdType O The normal descriptive name of the referenced object.
xs:string O Number identifying the individual location within the set of locations used by the Provider.
xs:int M The role of the provider in relation to the assessment task, e.g. assessing provider, assessment location provider, assessment provider, registering provider.
NZCodeSetsAssessmentProviderRoleType
Table A.114-1: ProviderInvolvedType
A.115 ProviderObjectReferenceType
A reference to a Provider Data Object
Figure A.115-1: ProviderObjectReferenceType
Element/@Attribute Char Description Type ProviderObjectReferenceType A reference to a Provider Data Object
ProviderObjectReferenceType is the base type for the following data types: M The Ministry of Education Organisation Id of the referenced provider
MoEOrgIdType O The normal descriptive name of the referenced object.
xs:string O Number identifying the individual location within the set of locations used by the Provider.
xs:int
Table A.115-1: ProviderObjectReferenceType Example A.115-1: ProviderObjectReferenceType Example
A.116 RecognitionListType
List of awards and other types of recognition given to the student for this activity.
Figure A.116-1: RecognitionListType
Element/@Attribute Char Description Type RecognitionListType List of awards and other types of recognition given to the student for this activity.
List MR The nature of recognition given to the student for the
successful completion of work in a co-curricular or
extra-curricular activity.
xs:normalizedString
Table A.116-1: RecognitionListType
A.117 RecordAuditType
Holds the audit for a records, e.g. Created/Last Updated DateTime and Created/Last Updated By.
Figure A.117-1: RecordAuditType
Element/@Attribute Char Description Type RecordAuditType Holds the audit for a records, e.g. Created/Last Updated DateTime and Created/Last Updated By.
O The date and time the record being sent through was created in the source system.
xs:dateTime O The date and time the record was last updated.
xs:dateTime O The date and time the record was deleted.
xs:dateTime O The user that created the record in the source system.
ObjectReferenceType O The user that last updated the record.
ObjectReferenceType O The user that deleted the record.
ObjectReferenceType O The reason the record was deleted.
NZCodeSetsDeletedReasonType
Table A.117-1: RecordAuditType
A.118 RefIdType An object or element identifier.
Figure A.118-1: RefIdType
Element/@Attribute Char Description Type RefIdType An object or element identifier. GUIDType
Table A.118-1: RefIdType
A.119 ReflectionListType
A list of the reflections the staff member performed.
Figure A.119-1: ReflectionListType
Element/@Attribute Char Description Type ReflectionListType A list of the reflections the staff member performed.
List MR A reflection that a staff member performed about the physical restraint incident.
ReflectionType
Table A.119-1: ReflectionListType
A.120 ReflectionType
A reflection that a staff member performed about the physical restraint incident.
Figure A.120-1: ReflectionType
Element/@Attribute Char Description Type ReflectionType A reflection that a staff member performed about the physical restraint incident.
O Free text outlining the staff members thoughts on a type of reflection.
xs:normalizedString O The type of reflection that the staff member performed.
NZCodeSetsStaffRestraintReflectionTypeType
Table A.120-1: ReflectionType
A.121 RelatedLearningStandardsListType
A list of ObjectReferences to related LearningStandards.
Figure A.121-1: RelatedLearningStandardsListType
Element/@Attribute Char Description Type RelatedLearningStandardsListType A list of ObjectReferences to related LearningStandards.
List MR A member of the related LearningStandard list. RelatedLearningStandardType
Table A.121-1: RelatedLearningStandardsListType
A.122 RelatedLearningStandardType
A member of a list of related LearningStandard references.
Figure A.122-1: RelatedLearningStandardType
Table A.122-1: RelatedLearningStandardType
A.123 RelatedOrganisationListType
A list of an Organisation's related organisations
Figure A.123-1: RelatedOrganisationListType
Element/@Attribute Char Description Type RelatedOrganisationListType A list of an Organisation's related organisations
List MR RelatedOrganisationType
Table A.123-1: RelatedOrganisationListType JSON {
"RelatedOrganisationList": {
"RelatedOrganisation": [
{
"RefId": "0951bacf-fc88-4ed6-8113-11a6d6335c07",
"LocalId": "99102",
"Name": "Tai Tokerau",
"ObjectType": "Organisation",
"StartDate": "2010-04-12",
"Type": "LOF"
},
{
"RefId": "ac0871d9-6562-4209-ae86-abdb3661842b",
"LocalId": "99204",
"Name": "Masterton (Whakaoriori) Kāhui Ako",
"ObjectType": "Organisation",
"StartDate": "2013-10-31",
"Type": "34028"
}
]
}
}
Example A.123-1: Related Organisation List Example
A.124 RelatedOrganisationType
Extends ObjectReferenceType to add an extra element, OrganisationType,
describing the nature of the related organisation.
Figure A.124-1: RelatedOrganisationType
Element/@Attribute Char Description Type RelatedOrganisationType Extends ObjectReferenceType to add an extra element, OrganisationType,
describing the nature of the related organisation.
Extension of ObjectReferenceType O The GUUID of the referenced object
IdRefType O Local identifier representing the referenced object.
LocalIdType O The normal descriptive name of the referenced object.
xs:string O The type of the referenced object:
NZCodeSetsReferrableDataObjectsType O The start date of the relationship between the two organisations
xs:date O The end date of the relationship between the two organisations
xs:date M Code denoting the nature of the relationship between the two Organisations
NZCodeSetsOrganisationRelationshipTypeType
Table A.124-1: RelatedOrganisationType Example A.124-1: Kāhui Ako Related Organisation
A.125 RelatedToListType
List of objects that this document relates to, e.g. a Wellbeing Response or Characteristic, Physical Restraint.
Figure A.125-1: RelatedToListType
Element/@Attribute Char Description Type RelatedToListType List of objects that this document relates to, e.g. a Wellbeing Response or Characteristic, Physical Restraint.
List MR An object that this document relates to, e.g. a Wellbeing Response or Characteristic, Physical Restraint.
ObjectReferenceType
Table A.125-1: RelatedToListType
A.126 RelatedWellbeingEventListType
A Wellbeing Event gets created for every student involved in an event. This list links together all related Wellbeing Events.
Figure A.126-1: RelatedWellbeingEventListType
Element/@Attribute Char Description Type RelatedWellbeingEventListType A Wellbeing Event gets created for every student involved in an event. This list links together all related Wellbeing Events.
List MR ObjectReferenceType
Table A.126-1: RelatedWellbeingEventListType
A.127 RelationshipType
Describes the relationship between a Student and StudentContact.
Figure A.127-1: RelationshipType
Element/@Attribute Char Description Type RelationshipType Describes the relationship between a Student and StudentContact.
M Code representing the relationship.
NZCodeSetsRelationshipToStudentType O A free text description of relationship type, where
Relationship To Student Type is set to ‘Other’, eg
‘Au-pair’, ‘Neighbour’
xs:normalizedString
Table A.127-1: RelationshipType Example A.127-1: Relationship Example
A.128 ReligiousAffiliationListType
A list of one or more religions with which a person affiliates.
Figure A.128-1: ReligiousAffiliationListType
Element/@Attribute Char Description Type ReligiousAffiliationListType A list of one or more religions with which a person affiliates.
List MR NZCodeSetsReligionType
Table A.128-1: ReligiousAffiliationListType Example A.128-1: Relgious Affiliation List Example
A.129 RestraintAdministeredByListType
A list of the people who administered the physical restraint to the student.
Figure A.129-1: RestraintAdministeredByListType
Element/@Attribute Char Description Type RestraintAdministeredByListType A list of the people who administered the physical restraint to the student.
List MR The person who administered the physical restraint to the student.
RestraintAdministeredByType
Table A.129-1: RestraintAdministeredByListType
A.130 RestraintAdministeredByType
The person who administered the physical restraint to the student.
Figure A.130-1: RestraintAdministeredByType
Element/@Attribute Char Description Type RestraintAdministeredByType The person who administered the physical restraint to the student.
O The person who administered the physical restraint to the student.
ObjectReferenceType O Indicates whether or not the person involved has received training of the safe use of physical restraint.
NZCodeSetsYesOrNoCategoryType O Free text providing additional information about any training the person has had on the safe use pf physical restraint.
xs:normalizedString O The role of the person who administered the physical restraint to the student.
NZCodeSetsRestraintAdministeredByRoleType
Table A.130-1: RestraintAdministeredByType
A.131 RestraintDebriefingListType
A list of the debriefings that took place after the physical restraint incident occurred.
Figure A.131-1: RestraintDebriefingListType
Element/@Attribute Char Description Type RestraintDebriefingListType A list of the debriefings that took place after the physical restraint incident occurred.
List MR 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.
RestraintDebriefingType
Table A.131-1: RestraintDebriefingListType
A.132 RestraintDebriefingType
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.
Figure A.132-1: RestraintDebriefingType
Element/@Attribute Char Description Type RestraintDebriefingType 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.
O The date the debriefing about the use of physical restraint on the student occurred.
xs:date O The time the debriefing about the use of physical restraint on the student occurred.
xs:time O Free text outlining the findings of the debriefing in the use of physical restraint on the student.
xs:normalizedString O 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.
xs:normalizedString O Parent/caregiver comments made about the use physical restraint on the student.
xs:normalizedString O Student comments made about the use physical restraint on the them.
xs:normalizedString O The type of debriefing that occurred, e.g. staff, or student and parent/caregiver.
NZCodeSetsRestraintDebriefingTypeType O A list of the people that attended the debriefing.
AttendeeListType
Table A.132-1: RestraintDebriefingType
A.133 RestraintQuestionListType
A list of questions and their answers about the physical restraint incident.
Figure A.133-1: RestraintQuestionListType
Element/@Attribute Char Description Type RestraintQuestionListType A list of questions and their answers about the physical restraint incident.
List MR 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.
RestraintQuestionType
Table A.133-1: RestraintQuestionListType
A.134 RestraintQuestionType
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.
Figure A.134-1: RestraintQuestionType
Element/@Attribute Char Description Type RestraintQuestionType 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.
M The question asked about the physical restraint incident.
NZCodeSetsRestraintQuestionType O The answer to the question. Options are Yes or No.
NZCodeSetsYesOrNoCategoryType O A free text description providing additional information about the question if required.
xs:normalizedString
Table A.134-1: RestraintQuestionType
A.135 RestraintWitnessListType
A list of the people that witnessed the physical constraint.
Figure A.135-1: RestraintWitnessListType
Element/@Attribute Char Description Type RestraintWitnessListType A list of the people that witnessed the physical constraint.
List MR A person that witnessed the physical restraint incident.
ObjectReferenceType
Table A.135-1: RestraintWitnessListType
A.136 RoomListType
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.
Figure A.136-1: RoomListType
Element/@Attribute Char Description Type RoomListType 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.
List MR The school's local identifier for the Room in which the teaching
or scheduled activity is held.
Note: Does not refer to a Room SIF data object.
ObjectReferenceType
Table A.136-1: RoomListType
A.137 ScheduleCustomDayPeriodListType
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.
Figure A.137-1: ScheduleCustomDayPeriodListType
Element/@Attribute Char Description Type ScheduleCustomDayPeriodListType 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.
MR Generic object reference to a SchedulePeriod, along with
its custom start and end times, which are part of a 'CUSTOM'
ScheduleEvent.
ScheduleCustomDayPeriodType
Table A.137-1: ScheduleCustomDayPeriodListType
A.138 ScheduleCustomDayPeriodType
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.
Figure A.138-1: ScheduleCustomDayPeriodType
Element/@Attribute Char Description Type ScheduleCustomDayPeriodType 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.
Extension of ObjectReferenceType O The GUUID of the referenced object
IdRefType O Local identifier representing the referenced object.
LocalIdType O The normal descriptive name of the referenced object.
xs:string O The type of the referenced object:
NZCodeSetsReferrableDataObjectsType M The time the custom schedule period starts.
xs:time M The time the custom schedule period ends.
xs:time
Table A.138-1: ScheduleCustomDayPeriodType
A.139 ScheduleDayListType
A list of ScheduleDay object references.
Figure A.139-1: ScheduleDayListType
Element/@Attribute Char Description Type ScheduleDayListType A list of ScheduleDay object references.
List MR Generic object reference to a ScheduleAcademicDay in the list
ObjectReferenceType
Table A.139-1: ScheduleDayListType
A.140 ScheduleListType
A list of references to a set of Schedules
Figure A.140-1: ScheduleListType
Element/@Attribute Char Description Type ScheduleListType A list of references to a set of Schedules
List MR Generic object reference to a Schedule in the list.
ObjectReferenceType
Table A.140-1: ScheduleListType
A.141 SchedulePeriodTimeListType
A list of the periods that make up the bell schedule and their start and end times.
Figure A.141-1: SchedulePeriodTimeListType
Element/@Attribute Char Description Type SchedulePeriodTimeListType A list of the periods that make up the bell schedule and their start and end times.
List MR A period that makes up or partially makes up the bell schedule and its start and end times.
SchedulePeriodTimeType
Table A.141-1: SchedulePeriodTimeListType Example A.141-1: SchedulePeriodList Example
A.142 SchedulePeriodTimeType
The definition of a SchedulePeriod start and end time, on a particular Bell Schedule.
Figure A.142-1: SchedulePeriodTimeType
Element/@Attribute Char Description Type SchedulePeriodTimeType The definition of a SchedulePeriod start and end time, on a particular Bell Schedule.
M Generic object reference to the schedule period whose start and end times are being defined.
ObjectReferenceType M The time the period starts.
xs:time M The time the period ends.
xs:time
Table A.142-1: SchedulePeriodTimeType Example A.142-1: SchedulePeriodTime Example
A.143 ScheduleTermListType
A list of ScheduleTerm object references.
Figure A.143-1: ScheduleTermListType
Element/@Attribute Char Description Type ScheduleTermListType A list of ScheduleTerm object references.
List MR Generic object reference to a ScheduleTerm in the list
ObjectReferenceType
Table A.143-1: ScheduleTermListType
A.144 SchoolClassificationListType
A list of Classification elements, further describing the
nature of the school.
Figure A.144-1: SchoolClassificationListType
Element/@Attribute Char Description Type SchoolClassificationListType A list of Classification elements, further describing the
nature of the school.
List MR NZCodeSetsSchoolClassificationType
Table A.144-1: SchoolClassificationListType Example A.144-1: NZ School Classification List Example
A.145 SchoolServiceType
Contains Organisation properties that are specific to Organisations
that are Providers of School education services.
Figure A.145-1: SchoolServiceType
Element/@Attribute Char Description Type SchoolServiceType Contains Organisation properties that are specific to Organisations
that are Providers of School education services.
O A summary of the genders accepted by the school
NZCodeSetsSchoolCoEdStatusType O A description of the socio-economic position of a school's
student community according to the MoE decile rating system.
Examples 5
xs:integer O A list of recognised policy choices adopted by the School.
EnactedPolicyListType O Indicates whether or not the school has a student management system.
NZCodeSetsYesOrNoCategoryType O A list of School Classification descriptors that further describe the nature of a school
SchoolClassificationListType O A list of SchoolYear elements describing
the genders of students accepted for enrolment at each year
level.
SchoolYearLevelListType O
The name of the Technology Centre that is run as part of the School; Eg: Marlborough Technology Centre
is run as part of Bohally Intermediate School.
xs:normalizedString
Table A.145-1: SchoolServiceType JSON {
"SchoolService": {
"CoEdStatus": "JUBO",
"Decile": 5,
"NewEntrantPolicyList": {
"EnactedPolicy": [
{
"EffectiveTo": "2018-12-31",
"Policy": "AE"
},
{
"EffectiveFrom": "2019-01-01",
"Policy": "CE"
}
]
},
"SchoolClassificationList": {
"Classification": [
"52010",
"52004",
"52002"
]
},
"SchoolYearList": {
"SchoolYear": [
{
"YearLevel": "1",
"Gender": "C"
},
{
"YearLevel": "2",
"Gender": "C"
},
{
"YearLevel": "3",
"Gender": "C"
},
{
"YearLevel": "4",
"Gender": "C"
},
{
"YearLevel": "5",
"Gender": "C"
},
{
"YearLevel": "6",
"Gender": "C"
},
{
"YearLevel": "7",
"Gender": "C"
},
{
"YearLevel": "8",
"Gender": "C"
},
{
"YearLevel": "9",
"Gender": "F"
},
{
"YearLevel": "10",
"Gender": "F"
},
{
"YearLevel": "11",
"Gender": "F"
},
{
"YearLevel": "12",
"Gender": "F"
},
{
"YearLevel": "13",
"Gender": "F"
}
]
}
}
}
Example A.145-1: NZ School Service Example
A.146 SchoolYearLevelListType
A list of NZSchoolYearLevel elements, describing the Year Levels
taught by the School, and the Co-Ed Status of each year level.
Figure A.146-1: SchoolYearLevelListType
Element/@Attribute Char Description Type SchoolYearLevelListType A list of NZSchoolYearLevel elements, describing the Year Levels
taught by the School, and the Co-Ed Status of each year level.
List MR SchoolYearLevelType
Table A.146-1: SchoolYearLevelListType Example A.146-1: NZ School Year Level List Example
A.147 SchoolYearLevelType
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.
Figure A.147-1: SchoolYearLevelType
Element/@Attribute Char Description Type SchoolYearLevelType 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.
M Which year level are we describing?
xs:int M 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.
xs:int M Which genders are accepted for enrolment in this Year Level?
NZCodeSetsSchoolingGenderType O Says if the school has boarding and if so, if it is for girls only, boys only or both.
NZCodeSetsSchoolBoardingTypeType
Table A.147-1: SchoolYearLevelType
A.148 SocialGoalListType
A list of social goals the student has set.
Figure A.148-1: SocialGoalListType
Element/@Attribute Char Description Type SocialGoalListType A list of social goals the student has set.
List MR
BaseStudentGoalType
Table A.148-1: SocialGoalListType Example A.148-1: SocialGoalList
A.149 SpecialAssessmentConditionListType
A list of Special Assessment Conditions (SACs) that may be applied, or excluded form
a particular student's participation in an assessment task.
Figure A.149-1: SpecialAssessmentConditionListType
Element/@Attribute Char Description Type SpecialAssessmentConditionListType A list of Special Assessment Conditions (SACs) that may be applied, or excluded form
a particular student's participation in an assessment task.
List MR A single SAC that may be applied, or excluded from a student's participation in an assessment task.
NZCodeSetsSpecialAssessmentConditionType
Table A.149-1: SpecialAssessmentConditionListType
A.150 StaffInvolvedListType
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.
Figure A.150-1: StaffInvolvedListType
Element/@Attribute Char Description Type StaffInvolvedListType 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.
List MR The staff member involved with the assessment task and their role,
e.g. created the assessment task, moderator, marker.
StaffInvolvedType
Table A.150-1: StaffInvolvedListType
A.151 StaffInvolvedType
The staff member involved with the assessment task and their
role, e.g. created the assessment task, moderator, marker.
Figure A.151-1: StaffInvolvedType
Table A.151-1: StaffInvolvedType
A.152 StaffListStaffMemberType
The individual staff member as a member of the StaffList and their role.
Figure A.152-1: StaffListStaffMemberType
Element/@Attribute Char Description Type StaffListStaffMemberType The individual staff member as a member of the StaffList and their role.
Extension of ObjectReferenceType O The GUUID of the referenced object
IdRefType O Local identifier representing the referenced object.
LocalIdType O The normal descriptive name of the referenced object.
xs:string O The type of the referenced object:
NZCodeSetsReferrableDataObjectsType M 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.
NZCodeSetsStaffRoleType
Table A.152-1: StaffListStaffMemberType
A.153 StaffListType
A list of associated staff members.
Figure A.153-1: StaffListType
Element/@Attribute Char Description Type StaffListType A list of associated staff members.
List MR The individual staff member as a member of the StaffList and their role.
StaffListStaffMemberType
Table A.153-1: StaffListType
A.154 StaffReflectionListType
A list of the reflections made by the staff members who applied the physical restraint.
Figure A.154-1: StaffReflectionListType
Element/@Attribute Char Description Type StaffReflectionListType A list of the reflections made by the staff members who applied the physical restraint.
List MR The reflections performed by the staff member who applied the physical restraint to the student.
StaffReflectionType
Table A.154-1: StaffReflectionListType
A.155 StaffReflectionType
The reflections performed by the staff member who applied the physical restraint to the student.
Figure A.155-1: StaffReflectionType
Element/@Attribute Char Description Type StaffReflectionType The reflections performed by the staff member who applied the physical restraint to the student.
O The date the staff member performed their reflection on the use of physical restraint on the student.
xs:date O The staff member that witnessed the person who applied the restraint performing the staff reflections.
ObjectReferenceType O The staff member who performed the staff reflection.
ObjectReferenceType O A list of the reflections the staff member performed.
ReflectionListType
Table A.155-1: StaffReflectionType
A.156 StaffSubjectListType
Subject(s) Staff member is eligible to teach.
Figure A.156-1: StaffSubjectListType
Element/@Attribute Char Description Type StaffSubjectListType Subject(s) Staff member is eligible to teach.
List MR This element contains Staff subjects they are eligible to teach together with the teaching preference.
StaffSubjectType
Table A.156-1: StaffSubjectListType
A.157 StaffSubjectType
This element contains Staff subjects they are eligible to teach together with the teaching preference.
Figure A.157-1: StaffSubjectType
Element/@Attribute Char Description Type StaffSubjectType This element contains Staff subjects they are eligible to teach together with the teaching preference.
O Priority of Subject to Teach.
xs:unsignedInt M NZ education standardised code denoting LearningArea / SubjectArea
NZCodeSetsSubjectAreaType O 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.
YearLevelList
Table A.157-1: StaffSubjectType
A.158 StatisticalAreaListType
A list of Statistical Areas. It may contain
a StatisticalArea element for each of the
following spatial unit types:
Ward
Urban Area
Census Area Unit
Māori Electorate
Mesh Block
General Electorate
Territorial Authority
Local Board (Auckland Only)
Regional Council
Figure A.158-1: StatisticalAreaListType
Element/@Attribute Char Description Type StatisticalAreaListType A list of Statistical Areas. It may contain
a StatisticalArea element for each of the
following spatial unit types:
Ward Urban Area Census Area Unit Māori Electorate Mesh Block General Electorate Territorial Authority Local Board (Auckland Only) Regional Council List MR A code denoting one of the following spacial unit types:
StatisticalAreaType
Table A.158-1: StatisticalAreaListType Example A.158-1: NZ Statistical Area List Example
A.159 StatisticalAreaType
A particular statistical area defined by Statistics New Zealand.
Figure A.159-1: StatisticalAreaType
Table A.159-1: StatisticalAreaType Example A.159-1: NZ Statistical Area Example
A.160 StrandAchievementObjectiveListType
A record of the Student's progress in a set of achievement objectives from the
Technology curriculum strand, that was covered in the class.
Figure A.160-1: StrandAchievementObjectiveListType
Element/@Attribute Char Description Type StrandAchievementObjectiveListType A record of the Student's progress in a set of achievement objectives from the
Technology curriculum strand, that was covered in the class.
List MR A record of the Student's progress in a particular achievement objective
from the Technology curriculum strand, that was covered in the class.
StrandAchievementObjectiveType
Table A.160-1: StrandAchievementObjectiveListType
A.161 StrandAchievementObjectiveType
A record of the Student's progress in a particular achievement objective
from the Technology curriculum strand, that was covered in the class.
Figure A.161-1: StrandAchievementObjectiveType
Element/@Attribute Char Description Type StrandAchievementObjectiveType A record of the Student's progress in a particular achievement objective
from the Technology curriculum strand, that was covered in the class.
M Code denoting the particular achievement objective against which
the student's progress is being reported.
NZCodeSetsStrandAchievementObjectiveType O 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.
NZCodeSetsTechnologyCurriculumLevelType O Code denoting the level of progress the student has made against the particular learning
strand achievement objective. e.g. Beginner, Proficient, and Advanced.
NZCodeSetsStrandAchievementProgressLevelType O A description of what the achievement objective covers.
xs:normalizedString O A note about the student's overall effort in relation to this
achievement objective for this strand.
xs:normalizedString O A description of practical ability covered by the
achievement objective for the strand.
xs:normalizedString O A note about the student's practical ability progress in relation to
this achievement objective for this strand.
xs:normalizedString O Documents that relate to students progress in this strand achievement
objective, e.g. report, photos, media, documents etc.
DocumentListType
Table A.161-1: StrandAchievementObjectiveType
A.162 StudentConsentListType
A list of student consent information.
Figure A.162-1: StudentConsentListType
Element/@Attribute Char Description Type StudentConsentListType A list of student consent information.
MR Generic object reference to a StudentConsent data object that records the student's consent to
a particular action taking place.
ObjectReferenceType
Table A.162-1: StudentConsentListType
A.163 StudentCourseChoiceListType
A list of course choices that can be made, or have been made by a Student.
Figure A.163-1: StudentCourseChoiceListType
Element/@Attribute Char Description Type StudentCourseChoiceListType A list of course choices that can be made, or have been made by a Student.
List MR An individual Course choice that can be made, or has been made by a Student.
StudentCourseChoiceType
Table A.163-1: StudentCourseChoiceListType Example A.163-1: Student Course Choice List Example
A.164 StudentCourseChoiceType
An individual Course choice that can be made, or has been made by a Student.
Figure A.164-1: StudentCourseChoiceType
Element/@Attribute Char Description Type StudentCourseChoiceType An individual Course choice that can be made, or has been made by a Student.
O The student's preference for this course, with respect
to the other course choices in the list.
xs:unsignedInt M Generic object reference to the Course the student has chosen to study during the year.
ObjectReferenceType
Table A.164-1: StudentCourseChoiceType Example A.164-1: Student Course Choice Example
A.165 StudentECEEnrolmentType
Defines information related to a student's enrolment at
an Early Childhood Education (ECE) Provider.
Placeholder for future expansion.
Figure A.165-1: StudentECEEnrolmentType
Element/@Attribute Char Description Type StudentECEEnrolmentType Defines information related to a student's enrolment at
an Early Childhood Education (ECE) Provider.
Placeholder for future expansion.
O Code set denoting the year level of students attending early childhood education.
NZCodeSetsECEYearLevelType O Code denoting which part of the National Curriculum (NZ Curriculum or Te Marautanga o Aotearoa) the ECE learner is enrolled in.
NZCodeSetsCurriculumType
Table A.165-1: StudentECEEnrolmentType
A.166 StudentInterestListType
A list of interestes the student has set.
Figure A.166-1: StudentInterestListType
Element/@Attribute Char Description Type StudentInterestListType A list of interestes the student has set.
List MR
StudentInterestType
Table A.166-1: StudentInterestListType Example A.166-1: StudentInterestList
A.167 StudentInterestType
Object recording an interest the student has expressed.
Figure A.167-1: StudentInterestType
Element/@Attribute Char Description Type StudentInterestType Object recording an interest the student has expressed.
O The date the Student's interest was recorded.
xs:date O A description of the interest the student wants to achieve
xs:normalizedString O The name of the interest the student has expressed
xs:normalizedString O Code denoting the type of interest the student has expressed
NZCodeSetsStudentInterestTypeType O The subject area the student has expressed an interest in.
NZCodeSetsSubjectAreaType
Table A.167-1: StudentInterestType Example A.167-1: StudentInterest
A.168 StudentListType
A list of references to the set of Students who are assigned to
the Teaching Group, SchoolCourse or AssessmentTask.
Figure A.168-1: StudentListType
Element/@Attribute Char Description Type StudentListType A list of references to the set of Students who are assigned to
the Teaching Group, SchoolCourse or AssessmentTask.
List MR Student reference in the StudentList.
StudentObjectReferenceType
Table A.168-1: StudentListType
A.169 StudentObjectReferenceType
A reference to a StudentPersonal Data Object, which may be via NSN rather than RefId or LocalId
Figure A.169-1: StudentObjectReferenceType
Element/@Attribute Char Description Type StudentObjectReferenceType A reference to a StudentPersonal Data Object, which may be via NSN rather than RefId or LocalId
StudentObjectReferenceType is the base type for the following data types:Extension of ObjectReferenceType O The GUUID of the referenced object
IdRefType O Local identifier representing the referenced object.
LocalIdType O The normal descriptive name of the referenced object.
xs:string O The type of the referenced object:
NZCodeSetsReferrableDataObjectsType O The NSN of the referenced Student
xs:positiveInteger O The NSN of the referenced Student
xs:positiveInteger
Table A.169-1: StudentObjectReferenceType Example A.169-1: Complete StudentReferenceType Example Example A.169-2: Partial StudentReferenceType Example
A.170 StudentSchoolCoEnrolmentType
The identity of the other school where the Student is concurrently enrolled.
Figure A.170-1: StudentSchoolCoEnrolmentType
Element/@Attribute Char Description Type StudentSchoolCoEnrolmentType O The identity of the other school where the Student is concurrently enrolled.
M Generic object reference to the other school where the student is concurrently enrolled.
ObjectReferenceType O The type of CoEnrolment.
NZCodeSetsCoEnrolmentTypeType O Free text note of key behavioural issues, made by the client school in relation to the student.
xs:normalizedString O Free text confidential note made by the client school in relation to the student.
xs:normalizedString O Free text confidential note made by the parents/caregivers of the student.
xs:normalizedString
Table A.170-1: StudentSchoolCoEnrolmentType
A.171 StudentSchoolEnrolmentListType
A list of school enrolments, one for each academic year (or part thereof) that the Student
was enroled at the particular Provider.
Figure A.171-1: StudentSchoolEnrolmentListType
Element/@Attribute Char Description Type StudentSchoolEnrolmentListType A list of school enrolments, one for each academic year (or part thereof) that the Student
was enroled at the particular Provider.
List MR Defines information related to a student's enrolment at a school education Provider
for a particular academic year (or part thereof)
StudentSchoolEnrolmentType
Table A.171-1: StudentSchoolEnrolmentListType
A.172 StudentSchoolEnrolmentType
Defines information related to a student's enrolment at a school education Provider
for a particular academic year (or part thereof)
Figure A.172-1: StudentSchoolEnrolmentType
Element/@Attribute Char Description Type StudentSchoolEnrolmentType O Defines information related to a student's enrolment at a school education Provider
for a particular academic year (or part thereof)
O School year for which this enrolment is applicable,
expressed as the four-digit year in which the school year
ends (eg 2018).
xs:gYear O The date the student started at the school.
xs:date M The type of enrolment as it relates to this school,
eg whether base school, co-enrolment.
NZCodeSetsSchoolEnrolmentTypeType O 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.
xs:int O Records the Student's eligibility to enrol / for funding.
NZCodeSetsEligibilityCriteriaType O Records how the Student's eligibility to enrol / for funding was verified by the
school staff during the enrolment process.
VerificationEventType O 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.
xs:decimal O The student classification for MoE funding purposes
NZCodeSetsStudentFundingTypeType O Indicates the number of years for which funding has been provided by MoE. Must only contain values from 0 through to 15 inclusive.
xs:int M Code denoting which half of the National Curriculum
(NZ Curriculum or Te Marautanga o Aotearoa) the student is enrolled in.
NZCodeSetsCurriculumType M Which level of the National Curriculum (1-5) is the student enrolling in?
xs:unsignedInt O How much instruction has the student received in which languages?
LanguageOfInstructionListType O The number of years the student has been in Te Reo Māori immersion education.
xs:unsignedInt O Indicates whether or not the student is enrolled under a Section 9 agreement
NZCodeSetsYesOrNoCategoryType O NZQA details for a student for this school year.
NZQAEnrolmentType O Indicates the level of ORS funding the student receives.
NZCodeSetsOngoingResourceSchemeType O 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.
StudentSubjectChoiceListType O 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.
StudentCourseChoiceListType O Describes the student's enrolment with their base school in the
case where this enrolment is not a base school enrolment.
StudentSchoolCoEnrolmentType O Additional information collected for international enrolments.
InternationalSchoolEnrolmentType O A list of student consent information.
StudentConsentListType O The academic attainment goals of the student when they enrol, e.g. they wish to achieve a certain qualification.
AcademicAttainmentGoalListType O Details of why the school pre-enrolment was cancelled.
PreEnrolmentCancellationType
Table A.172-1: StudentSchoolEnrolmentType JSON {
"StudentSchoolEnrolment": {
"SchoolCalendarYear": 2018,
"MembershipType": "BASE",
"YearLevel": 11,
"EligibilityCriteria": "GAE",
"EligibilityVerification": {
"Source": "AUSPA",
"DocumentSerialNumber": "L905673",
"DocumentExpiryDate": "2019-03-30",
"IsConfirmed": true,
"Timestamp": "2003-11-30T12:34:56.7",
"Provider": {
"RefId": "822f6c83-2841-4a87-9ff9-49730951b3ba"
}
},
"FTE": 1.0,
"FundingType": "EX",
"FundingYearLevel": 11,
"Curriculum": "NZC",
"CurriculumLevel": 5,
"LanguageOfInstructionList": {
"Language": [
{
"Code": "NZS16110",
"Level": "6"
},
{
"Code": "NZS01112",
"Level": "1"
}
]
},
"SubjectChoiceList": {
"StudentSubjectChoice": [
{
"PreferenceNumber": 1,
"Code": "FREN"
},
{
"PreferenceNumber": 2,
"Code": "HIST"
}
]
},
"CourseChoiceList": {
"StudentCourseChoice": [
{
"PreferenceNumber": 1,
"Course": {
"LocalId": "Y11HIST"
}
},
{
"PreferenceNumber": 2,
"Course": {
"LocalId": "Y11FREN"
}
}
]
},
"InternationalEnrolment": {
"NZArrivalDate": "2018-05-02",
"ExchangeScheme": "STA"
}
}
}
Example A.172-1: International School Enrolment
A.173 StudentSubjectChoiceListType
A list of subject areas choices that can be made, or have been made by a Student.
Figure A.173-1: StudentSubjectChoiceListType
Element/@Attribute Char Description Type StudentSubjectChoiceListType A list of subject areas choices that can be made, or have been made by a Student.
List MR An individual Subject choice that can be made, or has been made by a Student.
StudentSubjectChoiceType
Table A.173-1: StudentSubjectChoiceListType Example A.173-1: Student Subject Choice List Example
A.174 StudentSubjectChoiceType
An individual Subject choice that can be made, or has been made by a Student.
Figure A.174-1: StudentSubjectChoiceType
Element/@Attribute Char Description Type StudentSubjectChoiceType An individual Subject choice that can be made, or has been made by a Student.
O The student's preference for this subject, with respect
to the other subject choices in the list.
xs:unsignedInt M MoE code denoting the chosen subject / learning area.
NZCodeSetsSubjectAreaType
Table A.174-1: StudentSubjectChoiceType Example A.174-1: Student Subject Choice Example
A.175 StudentTertiaryEnrolmentType
Defines information related to a student's enrolment at
a Tertiary Education Provider.
Placeholder for future expansion.
Figure A.175-1: StudentTertiaryEnrolmentType
Element/@Attribute Char Description Type StudentTertiaryEnrolmentType Defines information related to a student's enrolment at
a Tertiary Education Provider.
Placeholder for future expansion.
M The type of tertiary education the student is enrolling in.
xs:normalizedString
Table A.175-1: StudentTertiaryEnrolmentType
A.176 StudentVoiceListType
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).
Figure A.176-1: StudentVoiceListType
Element/@Attribute Char Description Type StudentVoiceListType 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).
List MR 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).
ObjectReferenceType
Table A.176-1: StudentVoiceListType
A.177 SubjectAreaListType
A list of code values denoting Learning Areas and Subjects from either the NZ Curriculum
or Te Marautanga o Aotearoa.
Figure A.177-1: SubjectAreaListType
Table A.177-1: SubjectAreaListType Example A.177-1: Subject Area List Example
A.178 SupportNeedExternalResponseType
Additional information for an external response.
Figure A.178-1: SupportNeedExternalResponseType
Table A.178-1: SupportNeedExternalResponseType
A.179 SupportNeedInternalResponseType
Additional information for an internal response.
Figure A.179-1: SupportNeedInternalResponseType
Table A.179-1: SupportNeedInternalResponseType
A.180 SupportNeedListType
A list of learning support needs that have been identified for the student.
Figure A.180-1: SupportNeedListType
Element/@Attribute Char Description Type SupportNeedListType A list of learning support needs that have been identified for the student.
List MR A learning support need that has been identified for the student.
SupportNeedType
Table A.180-1: SupportNeedListType
A.181 SupportNeedResponseListType
A list of responses made about a learning support need.
Figure A.181-1: SupportNeedResponseListType
Element/@Attribute Char Description Type SupportNeedResponseListType A list of responses made about a learning support need.
List MR A responses made for a learning support need.
ObjectReferenceType
Table A.181-1: SupportNeedResponseListType
A.182 SupportNeedResponseReviewListType
A list of the reviews made about the response.
Figure A.182-1: SupportNeedResponseReviewListType
Element/@Attribute Char Description Type SupportNeedResponseReviewListType A list of the reviews made about the response.
List MR A review of the response.
SupportNeedResponseReviewType
Table A.182-1: SupportNeedResponseReviewListType
A.183 SupportNeedResponseReviewType
A review of a support need response.
Figure A.183-1: SupportNeedResponseReviewType
Element/@Attribute Char Description Type SupportNeedResponseReviewType A review of a support need response.
M The staff member reviewed the response.
ObjectReferenceType M The date of the review.
xs:date M Free text comment about the review.
xs:normalizedString O The date of the next review.
xs:date O A list of attachments related to a learning support need response review.
DocumentListType
Table A.183-1: SupportNeedResponseReviewType
A.184 SupportNeedType
A learning support need that has been identified for the student.
Figure A.184-1: SupportNeedType
Element/@Attribute Char Description Type SupportNeedType A learning support need that has been identified for the student.
M A learning support need that has been identified for the student.
ObjectReferenceType O A list of responses made about a learning support need.
SupportNeedResponseListType
Table A.184-1: SupportNeedType
A.185 SuspensionContainerType
Container for details of a Removal/Suspension.
Figure A.185-1: SuspensionContainerType
Element/@Attribute Char Description Type SuspensionContainerType Container for details of a Removal/Suspension.
O 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.
NZCodeSetsSuspensionCategoryType O
WithdrawalTimeListType O 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.
xs:decimal O The date parent/carers were officially notified.
xs:date O The date and time at which a meeting with the student’s parents/carers was held to resolve the Suspension.
xs:dateTime O Comments about how the Suspension has been resolved, including any reparative actions the student needs to take.
xs:string O The date at which the student was permitted to return to school earlier than the agreed duration would have allowed.
xs:date
Table A.185-1: SuspensionContainerType
A.186 TeachingGroupEventListType
A list generic references to a set of TeachingGroupEvents
Figure A.186-1: TeachingGroupEventListType
Element/@Attribute Char Description Type TeachingGroupEventListType A list generic references to a set of TeachingGroupEvents
List MR Generic object reference to a TeachingGroupEvent in the list
ObjectReferenceType
Table A.186-1: TeachingGroupEventListType
A.187 TechnologyClassListType
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.
Figure A.187-1: TechnologyClassListType
Element/@Attribute Char Description Type TechnologyClassListType 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.
List MR A record of the Student's progress in a particular class from the Technology curriculum.
TechnologyClass
Table A.187-1: TechnologyClassListType
A.188 TechnologyClassType
A record of the Student's progress in a particular class from the Technology curriculum.
Figure A.188-1: TechnologyClassType
Element/@Attribute Char Description Type TechnologyClassType A record of the Student's progress in a particular class from the Technology curriculum.
M A code denoting the technology class the progress report covers.
NZCodeSetsTechnologyClassType O Generic object reference to the staff member that taught the subject and assessed the student against the technology strand objectives.
ObjectReferenceType O Overall comment about the behaviour of the student over the course of the lessons in the Class.
xs:normalizedString O Overall comment about the effort the student has made in class
xs:normalizedString O A record of the Student's progress in a set of learning strands
from the Technology curriculum, that were covered in the class
ClassStrandListType
Table A.188-1: TechnologyClassType
A.189 TeRitoConfigurationType
Indicates which features of the Te Rito platform the organisation has access to within the Te Rito platform.
Figure A.189-1: TeRitoConfigurationType
Element/@Attribute Char Description Type TeRitoConfigurationType Indicates which features of the Te Rito platform the organisation has access to within the Te Rito platform.
M Indicates whether or not the organisation has access to the data analysis dashboards within the Te Rito platform.
NZCodeSetsYesOrNoCategoryType M Indicates whether or not the organisation has access to the within the Te Rito platform.
NZCodeSetsYesOrNoCategoryType M Indicates whether or not the organisation has access to the VLE within the Te Rito platform.
NZCodeSetsYesOrNoCategoryType
Table A.189-1: TeRitoConfigurationType
A.190 TertiaryServiceType
Contains Organisation properties that are specific to Organisations
that are Providers of early tertiary education services.
Figure A.190-1: TertiaryServiceType
Element/@Attribute Char Description Type TertiaryServiceType Contains Organisation properties that are specific to Organisations
that are Providers of early tertiary education services.
M Code denoting the kind of Tertiary service. eg: University, Wananga, etc.
xs:string
Table A.190-1: TertiaryServiceType
A.191 VerificationEventType
A record of how information about a person has been
verified. For example, verification of name, date of
birth, citizenship.
Figure A.191-1: VerificationEventType
Element/@Attribute Char Description Type VerificationEventType A record of how information about a person has been
verified. For example, verification of name, date of
birth, citizenship.
M 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).
NZCodeSetsVerificationSourceType O The serial number on the document that was used to verify the name or birthdate.
xs:normalizedString O The expiry date on the document that was used to verify the name or birthdate.
xs:date M If true then verification has been confirmed by MoE.
xs:boolean O The date & time that the VerificationEvent took place.
xs:dateTime O Generic object reference to the provider (eg school) that provided the verification.
ObjectReferenceType
Table A.191-1: VerificationEventType Example A.191-1: Citizenship Verification Event Example
A.192 VerifiedNameType
Extension of BaseNameType including name verification data
Figure A.192-1: VerifiedNameType
Element/@Attribute Char Description Type VerifiedNameType Extension of BaseNameType including name verification data
Extension of BaseNameType O A title or prefix associated with the name.
xs:normalizedString C Also known as Last Name, although some cultures may not present a family name as the last name.
xs:normalizedString C 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.
xs:normalizedString O Where more than one Given Name, these may be combined
in one composite field or else populated in several
elements.
xs:normalizedString O 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.
NZCodeSetsYesOrNoCategoryType O 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’.
xs:normalizedString O 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.
NZCodeSetsYesOrNoCategoryType O 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’.
xs:normalizedString O Textual suffix like PHD, JP, BSc.
xs:normalizedString C A combination of all name elements as one composite text element
xs:normalizedString O
Where a person has more than one name, the usage type
distinguishes the purposes or their preference for use of
the name.
NZCodeSetsNameUsageTypeType O
Flag indicating that this name has been verified.
NZCodeSetsYesOrNoCategoryType O
The verification event that verified the person's name.
VerificationEventType
Table A.192-1: VerifiedNameType JSON {
"VerifiedName": {
"FamilyName": "Wesson",
"GivenName": "Melanie",
"MiddleName": "Joan",
"FamilyNameFirst": "N",
"PreferredFamilyName": "Wesson",
"PreferredFamilyNameFirst": "N",
"PreferredGivenName": "Mel",
"FullName": "Melanie Joan Wesson",
"Type": "LGL",
"IsVerified": "Y",
"Verification": {
"Source": "NZBIR",
"DocumentSerialNumber": "L905673",
"DocumentExpiryDate": "2019-03-30",
"IsConfirmed": true,
"Timestamp": "2003-11-30T12:34:56.7",
"Provider": {
"RefId": "822f6c83-2841-4a87-9ff9-49730951b3ba"
}
}
}
}
Example A.192-1: Verified Name Example
A.193 WellbeingAlertListType
A list of relevant Wellbeing Alerts for the student.
Figure A.193-1: WellbeingAlertListType
Element/@Attribute Char Description Type WellbeingAlertListType A list of relevant Wellbeing Alerts for the student.
List MR ObjectReferenceType
Table A.193-1: WellbeingAlertListType
A.194 WellbeingAppealListType
A list of relevant Wellbeing Appeals for the student.
Figure A.194-1: WellbeingAppealListType
Element/@Attribute Char Description Type WellbeingAppealListType A list of relevant Wellbeing Appeals for the student.
List MR ObjectReferenceType
Table A.194-1: WellbeingAppealListType
A.195 WellbeingCharacteristicListType
A list of relevant Wellbeing Characteristics for the student.
Figure A.195-1: WellbeingCharacteristicListType
Element/@Attribute Char Description Type WellbeingCharacteristicListType A list of relevant Wellbeing Characteristics for the student.
List MR ObjectReferenceType
Table A.195-1: WellbeingCharacteristicListType
A.196 WellbeingEventCategoryListType
List of Categories of the WellbeingEvent.
Figure A.196-1: WellbeingEventCategoryListType
Element/@Attribute Char Description Type WellbeingEventCategoryListType List of Categories of the WellbeingEvent.
List MR WellbeingEventCategoryType
Table A.196-1: WellbeingEventCategoryListType
A.197 WellbeingEventCategoryType
Figure A.197-1: WellbeingEventCategoryType
Table A.197-1: WellbeingEventCategoryType
A.198 WellbeingEventListType
A list of relevant Wellbeing Events for the student.
Figure A.198-1: WellbeingEventListType
Element/@Attribute Char Description Type WellbeingEventListType A list of relevant Wellbeing Events for the student.
List MR ObjectReferenceType
Table A.198-1: WellbeingEventListType
A.199 WellbeingEventSubCategoryListType
List of Categories of the WellbeingEvent.
Figure A.199-1: WellbeingEventSubCategoryListType
Element/@Attribute Char Description Type WellbeingEventSubCategoryListType List of Categories of the WellbeingEvent.
List MR WellbeingEventSubCategoryType
Table A.199-1: WellbeingEventSubCategoryListType
A.200 WellbeingEventSubCategoryType
Figure A.200-1: WellbeingEventSubCategoryType
Table A.200-1: WellbeingEventSubCategoryType
A.201 WellbeingPlanType
Repeatable Plan information.
Figure A.201-1: WellbeingPlanType
Element/@Attribute Char Description Type WellbeingPlanType Repeatable Plan information.
O Any notes that can be provided regarding the need that led to the plan.
xs:string O The GUID of a PersonalisedPlan Object if it exists and it can be provided.
ObjectReferenceType
Table A.201-1: WellbeingPlanType
A.202 WellbeingResponseListType
A list of relevant Wellbeing Responses for the student.
Figure A.202-1: WellbeingResponseListType
Element/@Attribute Char Description Type WellbeingResponseListType A list of relevant Wellbeing Responses for the student.
List MR ObjectReferenceType
Table A.202-1: WellbeingResponseListType
A.203 WithdrawalTimeListType
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.
Figure A.203-1: WithdrawalTimeListType
Element/@Attribute Char Description Type WithdrawalTimeListType 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.
List MR WithdrawalType
Table A.203-1: WithdrawalTimeListType
A.204 WithdrawalType
Repeatable Withdrawal.
Figure A.204-1: WithdrawalType
Element/@Attribute Char Description Type WithdrawalType Repeatable Withdrawal.
O The start date of the withdrawal.
xs:date O The end date of the withdrawal.
xs:date O Start time of the Withdrawal on that day.
xs:time O End time of the Withdrawal on that day.
xs:time O The school term the withdrawal took place in.
xs:integer O Generic reference to the TeachingGroup, StudentActivity, or TimeTableSubject that
the learner is withdrawn from.
ObjectReferenceType
Table A.204-1: WithdrawalType
A.205 YearLevelListType
A list of NZSchoolYearLevel elements, describing the Year Levels
taught to the Course or TeachingGroup.
Figure A.205-1: YearLevelListType
Element/@Attribute Char Description Type YearLevelListType A list of NZSchoolYearLevel elements, describing the Year Levels
taught to the Course or TeachingGroup.
List MR The student Year Level that the staff member is responsible for. e.g. "Junior Student Dean" could have responsibility for all students in year levels 9 and 10. May only contain the values 1 through to 13 inclusive.
xs:int
Table A.205-1: YearLevelListType Example A.205-1: NZ Year Level List Example
