Skip to content

Commit

Permalink
Merge pull request #27 from nsip/3.4.5-Initial-Draft
Browse files Browse the repository at this point in the history
3.4.5 initial draft
  • Loading branch information
LindaNSIP authored Sep 19, 2019
2 parents 7babfbd + 980ca2e commit 732ea11
Show file tree
Hide file tree
Showing 113 changed files with 6,576 additions and 969 deletions.
2 changes: 1 addition & 1 deletion 02_Introduction/Introduction-Datamodel.xml
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
<p>
With respect to the SIF Specification, educators and non-technical readers are typically interested in the pK-12 data objects
that can be shared and reported on by SIF-enabled applications in SIF implementations. This document, the <em>SIF Data Model Implementation Specification</em>, contains a <a href="DataModel.html">Data Model</a>
section in a format that should not be a barrier to readers with a some knowledge of <a href="http://https://www.w3.org/XML/">[XML]</a>.
section in a format that should not be a barrier to readers with some knowledge of <a href="http://https://www.w3.org/XML/">[XML]</a>.
More technical readers, including software architects,
developers and integrators, will also be interested in the separate <em>SIF Infrastructure Implementation Specification</em> document.
</p>
Expand Down
106 changes: 25 additions & 81 deletions 02_Introduction/custom/ChangeLog-Datamodel.xml
Original file line number Diff line number Diff line change
Expand Up @@ -6,101 +6,45 @@
xmlns="http://sifassociation.org/SpecGen">

<p>This release contains the following significant updates and extensions to the SIF specification.</p>
<h3>Additions/Changes since 3.4.3 (April, 2018)</h3>
<h3>Additions/Changes since 3.4.4 (April, 2019)</h3>
<h4>New Objects</h4>
<ul>
<li>StudentScoreJudgementAgainstStandard - Proposed by Catholic Education, Melbourne</li>
<li>FinancialQuestionnaireSubmission - Proposed for Australian Government, Collections Projects</li>
<li>AGStatusReport - Proposed for Australian Government, Collections Projects</li>
<li>AGAddressCollectionSubmission - Proposed for Australian Government, Collections Projects</li>
<li>WellbeingPersonLink - Proposed for Vic DET</li>
</ul>

<h4>New Types</h4>
<h4>Other Additons</h4>
<ul>
<li>StudentGroupListType - added to StudentSchoolEnrollment, Proposed by Simon Schools</li>
<li>PhotoPermissionListType - added to PersonPicture, Proposed for NSW 3PI Project</li>
<li>PreviousSchoolName - Contained in StaffAssignment</li>
<li>ESLSupport - Contained in StudentPersonal</li>
<li>PreviousSchoolName - Contained in StudentSchoolEnrollment</li>
<li>DestinationSchoolName - Contained in StudentSchoolEnrollment</li>
<li>FQReporting and FQReportingList - Contained in FQReportingCollection</li>
<li>AGReportingObjectResponseListType - Contained in AGStatusReport</li>
<li>AGReportingObjectResponseType - Contained in AGStatusReport</li>
<li>FQContextualQuestionListType - Contained in FQReporting</li>
<li>FQContextualQuestionType - Contained in FQReporting</li>
<li>FQItemListType - Contained in FQReporting</li>
<li>FQItemType - Contained in FQReporting</li>
<li>AGRuleListType - Contained in AGStatusReport</li>
<li>AGRuleType - Contained in AGStatusReport</li>
<li>SoftwareVendorInfoContainerType - Contained in AGStatusReport</li>
<li>EntityContactInfoType - Contained in FQReporting</li>
<li>RegistrationDetails - Contained in ContactInfoType</li>
<li>Qualifications - Contained in ContactInfoType</li>
<li>InterpreterRequired - Contained in DemographicsType</li>
</ul>
<li>WellbeingResponse– SuspensionContainerType – SuspensionNotes added, Proposed by Vic DET</li>
<li>MapInfo/MapReference added MapNumber, Proposed by Vic DET</li>
<li>Attendance Codes Added for Vic and NSW DET</li>
<li>Additions to Wellbeing Medical Categories and Sub Categories, Proposed by Vic DET</li>
<li>Additions to StudentPersonal/MostRecent and StudentSchoolEnrollment for Future AG Census Collection</li>
<li>Addition to StaffStatus codes, Proposed by Vic DET</li>
<li>StudentPersonal/PrePrimaryEducationHours – type of attendance care prior to kinder enrolment values added, Proposed by NSW DET</li>
<li>Added RoomInfo/AvailableForTimeTable and StaffAssignment/AvailableForTimetable - Proposed by NSW DET, 3PI project</li>
<li>Update to CodeSet, Staff Activity (1107) Primary/Secondary Combined Teacher - Proposed by Sentral</li>
<li>SymptomList added to WellbeingCharacteristic, Proposed by Vic DET</li>
<li>Flag added for International Students for StudentSchoolEnrollment, Proposed by NSW DET</li>
</ul>

<h4>New CodeSets</h4>
<ul>
<li>Permission Category Code - added to support PhotoPermissionList</li>
<li>Group Category Code - added to support StudentGroupList</li>
<li>AG Submission Status - added to support AG Collections - added in the errata release</li>
<li>Education Level - Primary or Secondary, Associated with AG Student Collections</li>
<li>Pre-Primary Education Hours - added to support PrePrimaryEducationHours</li>
<li>Student Boarding Status - added to support AG Collections</li>
</ul>
<h4>Changes</h4>
<ul>

<li>LearningStandardItemRefId changed from Optional Repeating to Optional (Error Correction)</li>
<li>NAPTestletContentType/TestletName changed from Mandatory to Optional for use with NAPLAN 2019</li>
<li>DomainScoreType/PlausibleScaledValueList changed from Mandatory Repeating to Mandatory (Error Correction)</li>
<li>StimulusType/TextDescriptor changed from Mandatory to Optional for use with NAPLAN 2019</li>
<li>SchoolCommonwealthId privacy rating changed to Low</li>
<li>Removed duplicate code ACDT, in TimeZone codeset</li>
<li>Changes to WellbeingEvent and WellbeingResponse Objects to cater for “groups” of students/people</li>
<li>HouseholdContactInfo/PreferenceNumber changed to Optional</li>
<li>Other minor typos, broken links and various descriptions updated</li>
<li>For errata Release - FQItemType - ‘FQComments’ now Optional </li>
<li>For errata Release - FQReporting- Contact Email, PhoneNumber now Mandatory.Name – Given Name and Family Name to be provided.</li>
<li>WellbeingAlert/WellbeingStartDate changed to Optional</li>
<li>Updates to codesets for Visa SubClass, Federal Electorates, ISO currency names.</li>
</ul>

<h4>The following elemnts of type changed from Mandatory Repeating to Optional Repeating for use with NAPLAN 2019</h4>
<ul>
<li>PlausibleScaledValueListType/PlausibleScaledValue</li>
<li>SubstituteItemListType/SubstituteItem</li>
<li>SubstituteItemType</li>
<li>CodeFrameTestItemListType/TestItem</li>
<li>CodeFrameTestItemType</li>
<li>StimulusLocalIdListType/StimulusLocalId</li>
<li>NAPTestItemListType/TestItem</li>
<li>NAPTestItem2Type</li>
<li>NAPCodeFrameTestletListType/Testlet</li>
<li>NAPTestletCodeFrameType</li>
<li>NAPStudentResponseTestletListType/Testlet</li>
<li>NAPTestletResponseType</li>
<li>NAPTestletItemResponseListType/ItemResponse</li>
<li>NAPTestletResponseItemType</li>
<li>NAPSubscoreListType/Subscore</li>
<li>NAPSubscoreType</li>
<li>NAPWritingRubricListType/NAPWritingRubric</li>
<li>NAPWritingRubricType</li>
<li>ScoreListType/Score</li>
<li>ScoreType</li>
<li>ScoreDescriptionListType/ScoreDescriptor</li>
<li>StimulusListType/Stimulus</li>
<li>StimulusType</li>
<li>ContentDescriptionListType/ContentDescription</li>
<li>PNPCodeListType/PNPCode</li>
<li>TestDisruptionListType/TestDisruption</li>
<li>TestDisruptionType</li>
<li>LanguageBaseType</li>

</ul>
<h4>Changes to CodeSets </h4>
<ul>
<li>Visa Sub Class Codes updated from https://immi.homeaffairs.gov.au/visas/getting-a-visa/visa-listing updated,Added - 790 Safe Haven </li>
<li>Changes to PNP Codes for NAPLAN 2019 -AIM, AAM, AVM, ALL - not in use for 2019; Values added, BNB, BNG, BNL, BNW, BNY, CAL, ENZ, EST, LFS, RZL, ZOF, ZTFAO </li>
<li>Added to Exit/Withdrawal Type codes: 1940 - Deceased, 1941 - Permanently incapacitated</li>
<li>Added to Relationship to Student codes: 40 - Medical Contact</li>
<li>Added to Attendance Codes: 619 - School endorsed religious event</li>
<li>In Errata Release - NAP Test Item Changes: HT (Hot Text) changed to TS, CO (Composite) changed to COMP, IO Order interaction changed to Interactive Order</li>
</ul>
<h3>Deletions</h3>
<ul>
<li>ResourceUsage and SystemRole remain marked for deprecation in 3.5</li>
</ul>


</Section>
223 changes: 223 additions & 0 deletions 06_DataModel/Custom/AU/AGAddressCollectionSubmission.xml
Original file line number Diff line number Diff line change
@@ -0,0 +1,223 @@
<DataObject name="AGAddressCollectionSubmission"
xmlns:xs="http://www.w3.org/2001/XMLSchema"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xi="http://www.w3.org/2001/XInclude"
xmlns:xhtml="http://www.w3.org/1999/xhtml"

xmlns="http://sifassociation.org/SpecGen">

<Key>@RefId</Key>
<EventsReported>true</EventsReported>
<Item>
<Element>AGAddressCollectionSubmission</Element>
<privacyRating>High</privacyRating>
<Description>
<p>Object for Australian Government collection submission collecting addresses of students from schools and school authorities</p>
</Description>
</Item>
<Item>
<Attribute>RefId</Attribute>
<Characteristics>M</Characteristics>
<privacyRating>High</privacyRating>
<Description>
<p>GUID for this Report. The application that owns this object is responsible for generating this unique Id.</p>
</Description>
<Type ref="CommonTypes" name="RefIdType"></Type>
</Item>

<Item>
<Element>AddressCollectionYear</Element>
<Characteristics>M</Characteristics>
<privacyRating>Low</privacyRating>
<Description>Data Year</Description>
<Type ref="CommonTypes" name="SchoolYearType"></Type>
</Item>

<Item>
<Element>ReportingAuthority</Element>
<Characteristics>C</Characteristics>
<privacyRating>High</privacyRating>
<Description>Authority who is submitting this Collection? This is Mandatory if being submitted on behalf of a school and not the school itself.</Description>
<Type name="xs:normalizedString"></Type>
</Item>

<Item>
<Element>ReportingAuthoritySystem</Element>
<Characteristics>O</Characteristics>
<privacyRating>High</privacyRating>
<Description>System of Reporting Authority if Systemic.</Description>
<Type name="xs:normalizedString"></Type>
</Item>
<Item>
<Element>ReportingAuthorityCommonwealthId</Element>
<Characteristics>M</Characteristics>
<privacyRating>Low</privacyRating>
<Description>
<p>Commonwealth identifier for the submitting entity.</p>
</Description>
<Type name="xs:normalizedString"></Type>
</Item>

<Item>
<Element>SystemSubmission</Element>
<Characteristics>O</Characteristics>
<privacyRating>Low</privacyRating>
<Description>Is this a System Submission?.</Description>
<Type ref="CommonTypes" name="AUCodeSetsYesOrNoCategoryType"/>
</Item>
<Item>
<Element>SoftwareVendorInfo</Element>
<Characteristics>M</Characteristics>
<privacyRating>Low</privacyRating>
<Description>
<p>
Container for elements containing information on the Software Product and Vendor.
</p>
</Description>
<Type ref="CommonTypes" name="SoftwareVendorInfoContainerType"/>
</Item>

<Item>
<Element>SubmissionContact</Element>
<Characteristics>M</Characteristics>
<privacyRating>High</privacyRating>
<Description>Information on the Contact for the submission.</Description>
<Type ref="CommonTypes" name="EntityContactInfoType"></Type>
</Item>

<Item>
<Element>AddressCollectionComments</Element>
<Characteristics>O</Characteristics>
<privacyRating>High</privacyRating>
<Description>General comments on this submission.</Description>
<Type name="xs:normalizedString"></Type>
</Item>


<Item>
<Element>AddressCollectionReportingList</Element>
<Characteristics>O</Characteristics>
<privacyRating>High</privacyRating>
<Description>
<p>A list of Address Collections.</p>
</Description>
<Type ref="CommonTypes" name="AddressCollectionReportingListType"></Type>
</Item>

<Item>
<Element>LocalCodeList</Element>
<Characteristics>O</Characteristics>
<privacyRating>High</privacyRating>
<Type ref="CommonTypes" name="LocalCodeListType"></Type>
</Item>

<Item>
<Element>SIF_Metadata</Element>
<Characteristics>O</Characteristics>
<privacyRating>High</privacyRating>
<Type ref="CommonTypes" name="SIF_MetadataType"></Type>
</Item>

<Item>
<Element>SIF_ExtendedElements</Element>
<Characteristics>O</Characteristics>
<privacyRating>High</privacyRating>
<Type ref="CommonTypes" name="SIF_ExtendedElementsType"></Type>
</Item>

<xhtml:Example xmlns="" name="AGAddressCollectionSubmission">

<AGAddressCollectionSubmission RefId="D3E34B35-9D75-101A-8C3D-00AA001A1652">
<AddressCollectionYear>2019</AddressCollectionYear> <!-- Data Year -->
<ReportingAuthority>Ballarat Diocese</ReportingAuthority>
<ReportingAuthoritySystem>Vic Catholic</ReportingAuthoritySystem>
<ReportingAuthorityCommonwealthId>012345</ReportingAuthorityCommonwealthId>
<SystemSubmission>N</SystemSubmission>
<SoftwareVendorInfo> <!--Optional information about the Vendor -->
<SoftwareProduct>Civica</SoftwareProduct>
<SoftwareVersion>Websys 1.0</SoftwareVersion>
</SoftwareVendorInfo>
<SubmissionContact>
<Name Type="LGL">
<FamilyName>Franklin</FamilyName> <!-- Collection Contact Family Name -->
<GivenName>Jennifer</GivenName> <!-- Collection Contact First Name -->
</Name>
<PositionTitle>Administrator</PositionTitle> <!-- Collection Contact Position -->
<Email Type="01">[email protected]</Email> <!-- Collection Contact EmailAddress -->
<PhoneNumber Type="0096"><Number>02 9637-2000</Number></PhoneNumber> <!-- Collection Contact Phone Number -->
</SubmissionContact>
<AddressCollectionComments>This comment is for this Address Collection.</AddressCollectionComments>
<AddressCollectionReportingList>
<AddressCollectionReporting>
<AddressCollectionRefId>D3E34B35-9D75-101A-8C3D-00AA001A1655</AddressCollectionRefId>
<SchoolInfoRefId>C4D54B35-9D75-101A-8C3D-00AA001A1689</SchoolInfoRefId> <!-- Optional - if it exists. If a School will be a SchoolInfoRefId -->
<LocalId>01011234</LocalId>
<StateProvinceId>01011234</StateProvinceId>
<CommonwealthId>012345</CommonwealthId> <!-- AGEID -->
<ACARAId>1234</ACARAId>
<EntityName>XXX Secondary College</EntityName>
<EntityContact>
<Name Type="LGL">
<FamilyName>Miller</FamilyName> <!-- Collection Contact Family Name -->
<GivenName>James</GivenName> <!-- Collection Contact First Name -->
</Name>
<PositionTitle>Auditor</PositionTitle> <!-- Collection Contact Position -->
<Email Type="01">[email protected]</Email> <!-- Collection Contact EmailAddress -->
<PhoneNumber Type="0096"><Number>03 9637-2000</Number></PhoneNumber> <!-- Collection Contact Phone Number-->
</EntityContact>
<AddressCollectionStudentList>
<AddressCollectionStudent>
<LocalId>12345</LocalId>
<EducationLevel>Primary</EducationLevel>
<BoardingStatus>D</BoardingStatus>
<StudentAddress Type="0123" Role="012B">
<Street>
<Line1>The House</Line1>
<Line2>2819 Warburton Hwy</Line2>
</Street>
<City>Chicago</City>
<StateProvince>WA</StateProvince>
<PostalCode>60611</PostalCode>
</StudentAddress>
<Parent1>
<ParentName Type="LGL">
<FamilyName>Miller</FamilyName> <!-- Collection Parent Family Name -->
<GivenName>James</GivenName> <!-- Collection Parent First Name -->
<PreferredGivenName>Jim</PreferredGivenName> <!-- Collection Parent Preferred First Name -->
</ParentName>
<AddressSameAsStudent>Y</AddressSameAsStudent>
<ParentAddress Type="0123" Role="012B">
<Street>
<Line1>The House</Line1>
<Line2>2819 Warburton Hwy</Line2>
</Street>
<City>Chicago</City>
<StateProvince>WA</StateProvince>
<PostalCode>60611</PostalCode>
</ParentAddress>
</Parent1>
<Parent2>
<ParentName Type="LGL">
<FamilyName>Miller</FamilyName> <!-- Collection Parent Family Name -->
<GivenName>Samantha</GivenName> <!-- Collection Parent First Name -->
<PreferredGivenName>Sam</PreferredGivenName> <!-- Collection Parent Preferred First Name -->
</ParentName>
<AddressSameAsStudent>Y</AddressSameAsStudent>
<ParentAddress Type="0123" Role="012B">
<Street>
<Line1>The House</Line1>
<Line2>2819 Warburton Hwy</Line2>
</Street>
<City>Chicago</City>
<StateProvince>WA</StateProvince>
<PostalCode>60611</PostalCode>
</ParentAddress>
</Parent2>
</AddressCollectionStudent>
</AddressCollectionStudentList >
</AddressCollectionReporting>
</AddressCollectionReportingList>
</AGAddressCollectionSubmission>

</xhtml:Example>
</DataObject>
Loading

0 comments on commit 732ea11

Please sign in to comment.