Skip to main content
Skip table of contents

TX Interchange Student Restraint

The interchange schema for Student Restraint is used to report the restraint events for the Summer Collection of PEIMS.

Report Input

Each of the available run options and data fields for the report are described below.

Field

Description

Select Schools

At the District Level:

  • Select All Schools to run the extract for all schools not excluded from state reporting.
  • Select Multiple Schools allows the user to use the Ctrl or SHIFT key on your keyboard to click each school you want to run the extract.

At the School Level:

  • Select All Schools to run the extract for all schools not excluded from state reporting.
  • Select Current School Only to run the extract just for the current school.

Collection Code

Choose the Collection from the pop-up menu for the report generated. This option controls the naming of the file. 

School Year

Choose the Collection from the pop-up menu for the report generated.

Run Now

Select this option if the user wants to run the report immediately.

Schedule

Select this option if the user wants to run this report on a scheduled basis. Once this option is selected the following choices are:

  • Run Once
    • Start Date and Start Time to run the report.
  • Repeat
    • Select Daily, Weekly, Monthly or Yearly for the appropriate re-occurrence for running the report.
      • If Daily is selected, check the Weekdays only box to limit to weekdays.
      • If Weekly is selected, check which weekday to run the report.
      • If Monthly is selected, check the month to run the report.
      • If Yearly is selected, select either the date or the weekday to run the report.
  • Date Range – Select No End Date or a date that the re-occurrence should end.

Report Output: XML for PEIMS

Each of the fields displayed in the output of the report are described below. See Understanding the Report Output Table for a definition of each column in the table.

Filename for PEIMS:

The filename must be in the following format:

District Code: Position 1-6

Underscore: Position 7, 11, 21 and 34.

Campus ID: Position 8-10 – If the file is generated by a user from the District Office, this value is 000. If the file is generated by a user from a school, this value is the three-digit campus id for that user. This allows partial files to be submitted that contain data only for one school.

Collection Code: Position 12-20. This starts with the ending year of the school year followed by the five characters Collection Code (i.e. SUMR1).

Timestamp: Position 22-33 – This is YYYYMMDDHHMM where YYYY is year, MM is month, DD is day, HH is hour, and MM is minute.

Interchange: Position 35 starts the name of the Interchange – InterchangeStudentRestraintEventExtension.xml

Data Element

Description

[Table]FieldName

Collection

All restraint incidents with Date of Restraint within the school year being processed are included unless the Exclude from PEIMS option is set to Yes.

Restraint Event

Restraint Event Identifier

Restraint Instance Number

[S_TX_STU_Restraint_C]E1035_Instance_Number

SUMMER

Event Date

Date of Restraint

[S_TX_STU_Restraint_C]E1034_Restraint_Date

SUMMER

 

Student Reference

 

Student Identity

Student Unique State ID

Unique State Student Number

[Students]State_StudentNumber

SUMMER

 

Student Reference

 

School Reference

 

Educational Org Identity

State Organization ID

Campus where the restraint occurred.

[S_TX_STU_Restraint_C]E1032_Campus_ID

SUMMER

TX-Primary Restraint Reason

The restraint reason code.

[S_TX_STU_Restraint_C]E1033_Restraint_Reason

SUMMER

TX Reporting Period

The six-weeks reporting period in which the restraint occurred.

Calculated based on the Date of Restraint as compared to the Six Week Reporting Period dates in Years and Terms.

[Terms]FirstDay

[Terms]LastDay

[Terms]Portion

SUMMER

TX Instructional Setting

The instructional setting for the student if they are special education.

Note: This element is only reported if student has an active Special Education Program record at the time of the restraint event.

[S_TX_SEN_SPD_X]E0173_Instr_Setting

SUMMER

TX Restraint Staff

The code that describes the type of staff that did the restraining.

[S_TX_STU_Restraint_C]E1516_Restraint_Staff_Type

SUMMER

TX Special Education

The special ed indicator code that indicates if the student is special ed or not.

Calculated based on the Student's Instructional Setting in the Special Education record

[S_TX_SEN_SPD_X]E0173_INSTR_SETTING

SUMMER

TX-Primary Disability

The student’s primary disability at the time of the event if the student is special education.

Note: This element is only reported if student has an active Special Education Program record at the time of the restraint event.

[S_TX_SEN_SPD_X]E0041_Dis1

SUMMER

JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.