Ministry of Education Student Achievement and Supports XML Specifications

Ministry of Education
Student Achievement and Supports XML Specifications

Updated October 2018

Table of Contents

Revision History

Purpose of this Document

Student Achievement and Supports XML Dialogues

Typical Dialogues

Student Achievement and Supports XML Specification......

1.Objects

1.1StudentIntensiveSupports......

1.2StudentInclusionInterventionProgramPlan......

1.3StudentEnglishAdditionalLanguage......

1.4StudentProvincialAssessment......

2.Elements

2.1StudentIdentification

2.2IntensiveSupportInfo......

2.3WhoIsStudentInfo......

2.4LearningCapacityInfo......

2.5AssessmentInfo......

2.6MedicalInfo......

2.7AreaOfDevelopmentInfo......

2.8TransitionPlanningInfo......

2.9AdditionalNotesInfo......

2.10MeasureableOutcomeInfo......

2.11ServiceInfo......

2.12EducationInstituteServiceInfo......

2.13SchoolDivisionServiceInfo......

2.14OtherAgencyServiceInfo......

2.15OutcomeAssessmentInfo......

2.16EnglishAdditionalLanguageInfo......

2.17ProvincialAssessmentInfo......

3.Queries......

3.1QueryByStudent......

3.2QueryBySchool......

4.Message Infrastructure

4.1SAS_Message

4.2SAS_Header

4.3SAS_Event

4.4SAS_Request

4.5SAS_Response

4.6SAS_Ping

Appendix A – Additional Edits

SchoolId......

SAS_Query......

Revision History

Date / Version / Changes
2013Mar 15 / Pre-release
2013 Aug 20 / 1.0 / Removed Strength and Interest elements
2013 Oct 07 / 1.0 / Renamed Outcome elements for clarity
2013 Dec 18 / 1.1 / Added student assessment objects and elements
2014 Jan 16 / 1.1 / Simplified student assessment elements
2014 Apr 4 / 1.1 / Changed ‘ORR’ student assessment to ‘Regina Public Assessment’
2014 May 5 / 1.1 / Changed object and element names for numeracy and literacy assessments to StudentProvincialAssessment / ProvincialAssessmentInfo from StudentStandardizedAssessment / StandardizedAssessmentInfo.
2014 Aug 27 / 1.2 / Added AssessmentLevel code values 140-142. See page 29
2014 Dec 10 / 1.2 / Corrected the typo in the header information on page 34 and page 36
2014 Dec 18 / 1.2 / Updated Intensive Supports disability code values.

Purpose of this Document

This document presents the format of XML for exchanging Student Achievement and Supports information between partners. It does not address the technology of transmitting and receiving messages (i.e. transport layer).

Student Achievement and Supports XML Dialogues

An XML dialogue, whether real-time or batch, consists of one or more messages sent from a school to the Ministry of Education, and one or more messages sent from the Ministry of Education back to the school or school division (at minimum, the Ministry of Education returns acknowledgement that it received the original messages).

Note that the dialogues presented below imply nothing about the timing of sending messages – they are the same regardless of whether the school accumulates messages and sends them in a batch or sends them real-time.

Message types include:

Events (new or changed data)
Requests for data
Responses to requests and events

Typical Dialogues

Student Achievement and Supports XML Specification

The Ministry of Education (MOE) Student Achievement and Supports XML specification defines how XML is structured for communication between schools / school divisions and The Ministry of Education. It was designed using the Schools Interoperability Framework (SIF) Implementation Specification (see as a starting point, but is not compliant with SIF.

The MOEStudent Achievement and Supports XML specification defines the structure of each object. Each object consists of one or more elements, some of which contain additional elements within them. Elements may also contain attributes that define the element. An element that contains elements and/or an attributes is called a complex element. An element that does not is called a simple element.

Elements and attributes are strings unless otherwise indicated. All dates are in the format YYYY-MM-DD. Other restrictions on the format and/or contents of the strings are indicated in the specifications below and in Appendix B. Any element or attribute that is not considered valid will be rejected and could cause the rejection of the entire object it is part of. Syntax for elements and attributes follows standard XML syntax.

Note that each object is assigned a RefId (reference ID), which, for event messages, must be unique within the XML message, so that responses can refer to it. A response, whether it is an error message or data returned (e.g., return of a student’s Learning ID Number), will use the same RefId as the object it is responding to.

Queries are also assigned a RefId, which must be unique within the request XML message. If a query returns many objects (e.g., one query asks for course information on all students enrolled in a term), all the returned objects will include the RefId of the query.

In the MOEStudent Achievement and Supports XML specifications:

For an element A included in a complex element B, “required” means that if element B is included in an object, it must include element A within it. However, if element B is not included in the object, element A is not required.
For an element A that is included in an object without being part of a complex element, “required” means that element A must be included in the object.
For an attribute A of an element B, “required” means that if element B is included in an object, attribute A must be included and given a value.
Elements can have multiple values only if the specification indicates that they are “repeatable”.

Note that references to rules – e.g., (rule DAT-LE-058) or (rule enforced by database constraint) – are for internal use by the Ministry of Education. Vendors can ignore these.

1.Objects

The following objects support transmission of data between schools and the Ministry of Education. Schools send objects to the Ministry of Education with action codes to indicate whether each object is to be created, updated or deleted (with limitations on what can be deleted). See section 4.3SAS_Event for more information on action codes.

Objects are also used to send data from The Ministry of Education to schools, on request.

Each object consists of a RefId plus one or more elements. The RefId is used to refer to the object in any messages returned, and must be unique within an event XML message. (For responses to queries, the RefId is used to identify the query the object is a response to.) Elements without a description in this section are complex elements, which are described in section 2 Elements.

1.1StudentIntensiveSupports

This object allows the school or school division to submit Intensive Supports information for a student.

Element / Attribute / Status / Description/Notes
StudentIntensiveSupports / Provides information about a student’s Intensive Support requirements
RefID / Required / The reference ID for returning messages
StudentIdentification / Required / Element 2.1
IntensiveSupportInfo / Required / See “IntensiveSupportInfo”,Element 2.2.

Example

<SAS_EventObject ObjectName="StudentIntensiveSupports" Action="Add">

</StudentIdentification>

</IntensiveSupportInfo>

</StudentIntensiveSupports

</SAS_EventObject>

1.2StudentInclusionInterventionProgramPlan

This object allows the school or school division to submit Inclusion and Intervention Program Plan (eIIP) information for a student.

Element / Attribute / Status / Description/Notes
StudentInclusionInterventionProgramPlan / Provides information about a student’s inclusion intervention program plan
RefID / Required / The reference ID for returning messages
SchoolYear / Optional / The school year of the student’s personal program plan, expressed as both four-digit calendar years that the school year spans with a hyphen between (e.g. “2012-2013”).
Default is current school year based on calendar date
StudentIdentification / Required / Element 2.1
WhoIsStudentInfo / Optional / See “WhoIsStudentInfo” Element 2.3
LearningCapacityInfo / Optional / See “LearningCapacityInfo” Element 2.4
AssessmentInfo / Optional and Repeatable / See “AssessmentInfo” Element 2.5
MedicalInfo / Optional / See “MedicalInfo” Element 2.6
AreaOfDevelopmentInfo / Optional and Repeatable / See “AreaOfDevelopmentInfo” Element 2.7
TransitionPlanningInfo / Optional / See “TransitionPlanningInfo” Element 2.8
AdditionalNotesInfo / Optional / See “AdditionalNotesInfo” Element 2.9
MeasureableOutcomeInfo / Optional and Repeatable / See “MeasureableOutcomeInfo” Element 2.10
ServiceInfo / Optional and Repeatable / See “ServiceInfo” Element 2.11
OutcomeAssessmentInfo / Optional and Repeatable / See “OutcomeAssessmentInfo” Element 2.15

1.3StudentEnglishAdditionalLanguage

This object allows the school to submit English as an Additional Language requirements for a student.

Element / Attribute / Status / Description/Notes
StudentEnglishAdditionalLanguage / Provides information about a student’s English as an Additional Language requirements
RefID / Required / The reference ID for returning messages
StudentIdentification / Required / Element 2.1
EnglishAdditionalLanguageInfo / Required / See “EnglishAdditionalLanguageInfo” Element 2.16

Example

SAS_EventObject ObjectName="StudentEnglishAdditionalLanguage" Action="Add">

StudentEnglishAdditionalLanguageRefId="1">

StudentIdentification

DeptAssignedPersonId123456789</DeptAssignedPersonId

BirthDate1989-10-31</BirthDate

</StudentIdentification

EnglishAdditionalLanguageInfo

SchoolId1234567</SchoolId

ProficiencyLevel Code="01" SelectedCode="Yes"/>

</ EnglishAdditionalLanguageInfo

</ StudentEnglishAdditionalLanguage

</SAS_EventObject

1.4StudentProvincialAssessment

This object allows the school or school division to submit provincial assessment (literacy and numeracy)information for a student.

Element / Attribute / Status / Description/Notes
StudentProvincialAssessment / Provides information about a student’s provincial assessments.
RefID / Required / The reference ID for returning messages
StudentIdentification / Required / Element 2.1
ProvincialAssessmentInfo / Required and Repeatable / See “ProvincialAssessmentInfo”, Element 2.17.

Example

SAS_EventObject ObjectName="StudentProvincialAssessment" Action="Add">

StudentProvincialAssessment RefId="1">

StudentIdentification

DeptAssignedPersonId123456789</DeptAssignedPersonId

BirthDate1989-10-31</BirthDate

</StudentIdentification

ProvincialAssessmentInfo

SchoolId1234567</SchoolId

AssessmentTool Code="07"SelectedCode="Yes"/>

AssessmentElement Code="02"/>

AssessmentLevel Code=”100”/>

AssessmentDate>2013-09-01</AssessmentDate>

</ProvincialAssesmentInfo

</ StudentProvincialAssessment

</SAS_EventObject

2.Elements

These elements are used within the objects described in section 1 Objects.

2.1StudentIdentification

Used to identify a student. If DeptAssignedPersonId (Learning ID Number) is included and BirthDate does not match the student’s birth date in the department’s database, the object containing this element is rejected.

Element

/ Attribute / Status / Description/Notes
StudentIdentification / Identifies a student (in conjunction with information in StudentInfo if the Learning ID Number is not included).
DeptAssignedPersonId / Optional / Learning ID Number (assigned by The Ministry of Education). Must be a 9-digit number that exists on the ministrySDS database.
BirthDate / Required / The student's date of birth. Used to ensure that the correct record is being referenced. Cannot be used to update the birth date of an existing student.

Example

</StudentIdentification>

2.2IntensiveSupportInfo

This element provides information about the Intensive Supports for a student.

Element / Attribute / Status / Description/Notes
IntensiveSupportInfo / Provides detailed information about a student’s Intensive Supports
SchoolId / Required / The department-assigned number of the school providing the Intensive Supports
SupportLevel / Required / Intensive Support level
Code / Required / See SupportLevel Code Values
SelectedCode / Required / See SupportLevel SelectedCode Values
Disability / Optional and Repeatable / Disability(s) to be added/removed from student’s Intensive Support profile. Only two disabilities will be accepted for a student; additional disabilities will be ignored.
Code / Required / See Disability Code Values
SelectedCode / Required / See Disability SelectedCode Values
StartDate / Optional / Effective start date of the disability(s). The start date must fall within the current school year. Defaults to date of XML if not specified.
EndDate / Optional / Effective end date of the disability(s). The end date must fall within the school year. Defaults to July 31 of the current school year if not specified. Rejected if prior to start date.

SupportLevel Code Values

01Occasional

02Frequent

SupportLevel SelectedCode Values

YesSupportLevel is required for student

NoSupportLevel is not required for student

Disability Code Values

01Blind or Visual Impairment

02Deaf or Hard of Hearing

03Intellectual Disability

04Mental Health Impairment

05[Deprecated – no longer used]

06Orthopaedic Disability

07Other Diagnosed

08Pervasive Developmental Disorder

09Physical Health Impairment

10Prenatal Substance Exposure

11Substance-related Disorders

12Undiagnosed

Disability SelectedCode Values

YesDisability exists for student (i.e. add disability)

NoDisability does not exist for student (i.e. remove disability)

Example

IntensiveSupportInfo

SchoolId1234567</SchoolId

SupportLevel Code="02" SelectedCode="Yes"/>

Disability Code="01" SelectedCode="Yes"/>

Disability Code="02" SelectedCode="Yes"/>

</IntensiveSupportInfo

2.3WhoIsStudentInfo

This element provides information about the eIIPstrengths, interests, and learning styles for a student.

Element / Attribute / Status / Description/Notes
WhoIsStudentInfo / Provides information about a student’s strengths, interests, and learning styles for his/her eIIP.
WhoIsStudent / Required / Narrative describing student strengths, interests, and learning styles.
WhoIsStudentDate / Required / Effective date of strengths, interests, and learning styles.

2.4LearningCapacityInfo

This element provides information about the eIIP Learning Capacity for a student.

Element / Attribute / Status / Description/Notes
LearningCapacityInfo / Provides information about a student’s learning capacity for his/her eIIP.
LearningCapacity / Required / Learning capacity
Code / Required / See LearningCapacity Code Values
SelectedCode / Required / See LearningCapacity SelectedCode Values
LearningCapacityDate / Required / Effective date of Learning capacity

LearningCapacity Code Values

01Above Average Ability – Capable of handling regular or extended curriculum (> 115 IQ)

02Average Ability – Capable of handling regular curriculum (~ 100 IQ)

03Low Average Ability – Requires classroom adaptations (~80 IQ)

04Borderline Intellectual Ability – Requires adaptations & individual programming (~60-80 IQ)

05Significant Cognitive Disability – Requires individualized programming (<55 IQ)

06Cognitive Ability Not Formally Assessed – No assessment information available

07Cognitive Ability Cannot be Classified – Full scale IQ cannot be calculated and/or reader is encouraged to review the assessment on file

08Cognitive Ability is not Known at this Time – Student is not assessable

LearningCapacity SelectedCode Values

YesLearningCapacity code exists for student (i.e. add Learning Capacity)

NoLearningCapacity code does not exist for student (i.e. remove Learning Capacity)

2.5AssessmentInfo

This element provides information about the eIIP Assessment for a student.

Element / Attribute / Status / Description/Notes
AssessmentInfo / Provides information about a student’s assessment for his/her eIIP.
DiagnosisStatus / Required / Diagnosis status for the student.
Code / Required / See DiagnosisStatus Code Values
SelectedCode / Required / See DiagnosisStatus SelectedCode Values
DiagnosisDescription / Required / Description of the student’s diagnosis.
ProfessionalDescription / Required / Professional / Agency who completed student’s diagnosis / assessment.
AssessmentYear / Required / Year student’s assessment was completed, in YYYY format.
AssessmentDate / Required / Effective date of student’s assessment.

DiagnosisStatus Code Values

01Undiagnosed

02Diagnosed

DiagnosisStatus SelectedCode Values

YesDiagnosisStatus code exists for student (i.e. add Diagnosis Status)

NoDiagnosisStatus code does not exist for student (i.e. remove Diagnosis Status)

2.6MedicalInfo

This element provides information about the eIIP Medical information for a student.

Element / Attribute / Status / Description/Notes
MedicalInfo / Provides information about a student’s medical information for his/her eIIP.
MedicalDescription / Required / Pertinent assessment, medications, or procedures that may impact student’s school performance.
MedicalDate / Required / Effective date of student’s medical information.

2.7AreaOfDevelopmentInfo

This element provides information about the eIIP Areas of Development for a student.

Element / Attribute / Status / Description/Notes
AreaOfDevelopmentInfo / Provides information about a student’s areas of development for his/her eIIP.
AreaOfDevelopment / Required / Specific area of development required for student.
Code / Required / See AreaOfDevelopment Code Values
SelectedCode / Required / See AreaOfDevelopment SelectedCode Values
SupportLevel / Required / Support level for the corresponding area of development
Code / Required / See SupportLevel Code Values
AreaOfDevelopmentDate / Required / Effective date of area of development

AreaOfDevelopment Code Values

01Academic Achievement

02Communication

03Health / Medical Need / Personal Care

04Independence

05Motor Skills

06Personal / Social Well-being

07Safety

08Sensory

09Transition – Daily

10Transition – Long-term

11Transition – Short-term

12Other

** Valid AreaOfDevelopment / SupportLevel codes:

AreaOfDeveopment Code / Valid SupportLevel Codes
01 / 01, 02, 03, 04
02 / 05, 06, 07, 08
03 / 09, 10, 11, 12
04 / 13, 14, 15, 16
05 / 17, 18, 19, 20
06 / 21, 22, 23, 24
07 / 25, 26, 27, 28
08 / 29, 30, 31, 32
09 / 33, 34, 35, 36
10 / 33, 34, 35, 36
11 / 33, 34, 35, 36
12 / none

AreaOfDevelopment SelectedCode Values

YesAreaOfDevelopment code exists for student (i.e. add Area of Development)

NoAreaOfDevelopment code does not exist for student (i.e. remove Area of Development)

SupportLevel Code Values

01Performing at or above expected achievement based on individual learning capacity.

02Performing at expected achievement with specific adaptations and supports based on individual learning capacity.

03Performing below expected achievement with specific adaptations and supports based on individual learning capacity.

04Unable to demonstrate expected achievement with intensive adaptations and supports based on individual learning capacity.

05Effectively understands and expresses ideas, thoughts, and needs in a manner similar to same-age peers.

06Occasionally has difficulty understanding and/or expressing ideas/thoughts and needs; requires prompts and supports.

07Frequently has difficulty understanding and/or expressing ideas, thoughts and needs; requires prompts and supports.

08Requires intensive support to communicate basic needs and wants.

09Completes tasks and follows instructions in a manner similar to same-age peers.

10Completes tasks and follows instructions with occasional assistance and supervision.

11Completes tasks and follows instructions with frequent assistance and supervision.

12Completes tasks with continuous assistance and supervision.

13Does not require assistance with age-expected motor activities.

14Occasionally requires assistance with certain age-expected motor activities.

15Frequently requires assistance with age-expected motor activities.

16Continuously requires assistance with age-expected motor activities.

17Readily regulates sensory information presented in the environment.

18Occasionally experiences difficulty regulating sensory information.

19Frequently experiences difficulty regulating sensory information.

20Continuously requires intensive, individual sensory programming to regulate sensory information.

21No threat of harm to self or others.

22Requires occasional supervision to ensure no harm to self or others.

23Requires frequent supervision and prompting to ensure no harm to self or others.

24Requires intensive supervision and behavioural intervention to ensure no harm to self or others.

25Generally demonstrated positive age-expected emotional health and social skills.

26Occasionally benefits from support in developing age-expected emotional health and social skills.

27Frequently benefits from support in developing age-expected emotional health and social skills.

28Requires intensive support in developing age-expected emotional health and social skills.

29No health needs and/or medical condition is currently well managed.

30Requires occasional monitoring and/or assistance with health and/or personal care needs.

31Requires frequent monitoring and/or assistance with health and/or personal care needs.

32Requires intensive monitoring and/or assistance with health and/or personal care needs.

33Does not require assistance during transitioning.

34Requires occasional assistance during transitioning.

35Requires frequent assistance during transitioning.

36Requires continuous assistance during transitioning.

37Does not require assistance.

38Requires occasional assistance.

39Requires frequent assistance.

40Requires continuous assistance.

2.8TransitionPlanningInfo

This element provides information about the eIIP Transition Planninginformation for a student.

Element / Attribute / Status / Description/Notes
TransitionPlanningInfo / Provides information about a student’s short and long-term transition planning for his/her eIIP.
TransitionDuration / Required / Duration of transition required for student
Code / Required / See TransitionDuration Code Values.
SelectedCode / Required / See TransitionDuration SelectedCode Values
TransitionPlanningDescription / Required / Description of transition planning.
TransitionPlanningDate / Required / Effective date of transition planning.

TransitionDuration Code Values

01Short-term

02Long-term

TransitionDuration SelectedCode Values

YesTransitionDuration code exists for student (i.e. add Transition Duration)

NoTransitionDuration code does not exist for student (i.e. remove Transition Duration)

2.9AdditionalNotesInfo

This element provides additional notes about the student’s eIIP.

Element / Attribute / Status / Description/Notes
AdditionalNotesInfo / Provides additional notesaboutthe student’s eIIP.
AdditionalNotes / Required / Narrative describing student additional notes.
AdditionalNotesDate / Required / Effective date of student additional notes.

2.10MeasureableOutcomeInfo

This element provides information about the Measureable Outcome evaluation for a student.

Element / Attribute / Status / Description/Notes
MeasureableOutcomeInfo / Measureable outcome information for student’s eIIP.
AreaOfDevelopment / Required / Area of development required for student.
Code / Required / See AreaOfDevelopment Code Values Element 2.7
MeasureableOutcomeTarget / Required / Narrative of desired measureable future outcome.
MeasureableOutcomeCurrent / Required / Narrative of current student status w/r to measureable outcome.
MeasureableOutcomeSource / Required / Source of measureable outcome assessment.
Code / Required / See MeasureableOutcomeSource Code Values
SelectedCode / Required / See MeasureableOutcomeSource SelectedCode Values
MeasureableOutcomeResponsibility / Required / Person responsible for measureable outcome assessment.
MeasureableOutcomeStrategies / Required / Strategies to support achievement of measureable student outcome.
MeasureableOutcomeEvaluationDate / Required / Effective date of measureable outcome evaluation.

MeasureableOutcomeSource Code Values