2 Introduction

2.1 Specification Organization

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 SIF Data Model Implementation Specification, contains a Data Model section in a format that should not be a barrier to readers with some knowledge of [XML]. More technical readers, including software architects, developers and integrators, will also be interested in the separate SIF Infrastructure Implementation Specification document.

The Preamble provides an abstract of SIF along with the SIF Association disclaimer and details regarding certification and compliance claims.
This Introduction outlines the organization of this specification document, provides conventions used in this document, and summarizes versioning of the specification. Highlights of additions/changes since the previous version of the specification are also provided.
The Data Model section provides definitions of the XML structure for common elements in the data model and all objects related to entities in the pK-12 environment. This section is organized by the working groups and task forces within the SIF Association that have defined common elements or objects.
The document concludes with various appendices including lists of code set values defined within SIF and in external documents, and ends with a list of references to other documents.

2.2 Document Conventions

2.2.1 Definitions

The first time a term or concept is defined, it may be emphasized.

2.2.2 Structure and Values

SIF message and object names, XML element tags, attribute names and values, and other codes or values are typically presented as in this sentence.

2.2.3 Examples

JSON

{ "xml": "Longer examples of XML,JSON or HTTP messages are typically numbered and presented as given here." }

XML

Longer examples of XML,JSON or HTTP messages are typically numbered and presented as given here.

Example 2.2.3-1: Examples Convention

2.2.4 JSON

Java Script Object Notation (JSON) is an alternate way to represent an object in a tree like structure. JSON is desirable for a variety of reasons including: good wire efficiency, strong programming support, and satisfactory human readability. Since SIF’s data models are formally defined using XML Schemas, JSON conversion is handled through one of two sets of rules.

Default: Goessner Notation, which uses schema-independent generic rules for ease of translation. [Goessner JSON]

Preferred: PESC JSON which uses schema-aware rules for consistent results. [PESC JSON]

2.2.5 References

References to other works occurring in this text are given in brackets, e.g. [REFERENCE]. The text in brackets corresponds to a key in the References appendix. Often when the text in the brackets duplicates surrounding text, the reference alone is used (e.g. [XML] instead of XML [XML]).

2.2.6 Terminology

The key words MUST, MUST NOT, REQUIRED, SHALL, SHALL NOT, SHOULD, SHOULD NOT, RECOMMENDED, MAY, OPTIONAL, when EMPHASIZED, are to be interpreted as described in [RFC 2119].

2.2.7 XML Diagrams

Quick overviews of XML structures, including messages, objects, common elements and types, are provided in XML diagrams. The following diagram illustrates the conventions typically encountered in SIF.

Figure 2.2.7-1: XML Diagram Conventions

XML elements are represented by rectangles with the name of the element in the upper portion and the type, if any, in the lower portion. Attributes are represented in the same fashion, but have an @ icon rather than a SIF icon. Elements and attributes that are optional have a circled ? (0 or 1 occurrence) to the left of the rectangle. Optional and mandatory repeatable elements are indicated by a circled * (0 or more occurrences) and + (1 or more occurrences), respectively. Element attributes are grouped together in a rectangular block and connected to the element with a line that turns at right angles. Ordered sequences of XML elements are bracketed by lines that turn at right angles. When a choice of XML elements is indicated, the elements are bracketed by angled lines. A choice of elements can occur within an element, or may be an unnamed choice of elements.

XML types are represented using the same conventions as for XML elements, though the type portion of the rectangle typically indicates a base type, if any.

The type name of any element, attribute or type may be prefixed with a ↓, indicating the type is restricted in some fashion by one or more XML Schema facets (e.g. enumeration). When the type is a union of types, a list of types is presented, each type separated by |; if the list of union types is long, the list may be marked with ellipses, e.g., | ...

In an actual XML diagram, element, type and attribute rectangles are usually linked to their corresponding definitions/descriptions in accompanying tables.

2.3 Version Numbers

The SIF Implementation Specification uses the following version numbering scheme:

major version . minor version . revision number (X.Y.Z)

Once a versioned specification (Specification Release) has been released, the contents of that version MUST NOT be modified. Any modifications MUST be released under a new Specification Version Number unless the modification is the correction of an error or update of documentation. Each Specification Release has an associated errata section in which modifications and corrections of the release are listed.

A Specification Version Number for a Specification Release uses conventions as follows:

A Specification Version Number MAY take the form X.Y.Z where X, Y, and Z are nonnegative integers (whole numbers), and MUST NOT contain leading zeroes. X represents the Major version, Y represents the Minor version, and Z represents the Revision version.
Each version number element MUST increase sequentially based on the guidelines defined within this document; for instance, 1.9.1 to 1.10 to 1.11 to 1.11.1 .
Precedence refers to how versions are compared to each other when ordered. Precedence MUST be calculated by separating the version into major, minor, revision identifiers in that order. Precedence is determined by the first difference when comparing each of these identifiers from left to right as follows: Major, Minor, and Revision versions are always compared numerically; for example, 1.0.0 < 2.0.0 < 2.1.0 < 2.1.1 .

An instance of a Specification Version Number is the canonical identifier for a Specification Release. The manner in which the Specification Version Number increments after a given Specification Release depends on the type and relative magnitude of changes being proposed in the new release as follows:

1. The Revision version number ( Z in x.y.Z, where x >= 0) MUST be incremented when specification changes are limited to backward compatible changes. If Z=0 then the convention is to drop the Revision number: for example, 3.1 instead of 3.1.0. Backward compatible changes include the following:

New data object.
New optional data object element.
New optional utility service object element.

2. The Minor version number ( Y in x.Y.z, where x > 0 ) MUST be incremented if new functionality is added to the specification. It MUST be incremented if any aspect of the specification is marked as deprecated. It MUST be incremented if any aspect of the specification is not backward compatible. (Backward compatible means any change that can be implemented by one participant (consumer, Environment or service provider) without requiring changes by other participants to maintaining the same level of interoperability.) It MAY be incremented if substantial new functionality or improvements are introduced. It MAY include changes that are categorized as ”Revision” level magnitude. The Revision version MUST be reset to 0 when the Minor version is incremented. Changes requiring a Minor version increment include the following:

New mandatory data object element.
New mandatory utility service object element.
Deprecate data object element.
Deprecate data object.
Deprecate utility service object element.
Deprecate utility service object.
Remove deprecated data object element.
Remove deprecated data object.
Remove deprecated utility service object element.
Remove deprecated utility service object.
Add support for additional authentication methods.
Add support for additional TLS version.
Any changes concerning security.
Any optional to mandatory change.
Add support for additional payload representations.

3. The Major version number ( X in X.y.z, where X > 0 ) MUST be incremented if a significant change is introduced to the specification. It MAY include changes categorized as Minor and Revision level changes. The Revision and Minor version numbers MUST be reset to 0 when the Major version is incremented. Changes requiring a Major version increment include the following:

Deprecate payload representation.
Remove deprecated payload representation.
Add support for a distinct data model namespace.
Replace (deprecate and remove) a locale data model.
Any significant change that requires the Major version to be incremented as deemed by the A4L Association Board for global specifications and Management Boards for locale data models.

2.4 Highlighted Additions/Changes

This release contains the following significant updates and extensions to the SIF specification.

Additions/Changes since 3.5.0 December, 2022

New Elements

ScheduledActivity/TimeTableChangeReasonList, requested by Timetabling Solutions, to provide rationale for timetabling change published through ScheduledActivity, and make it easier to process automatically.
ScheduledActivity/OverridePatch, to indicate whether timetabling change published through ScheduledActivity is to be processed as patch (omitted elements are preserved) or put (omitted elements are deleted).
Demographics/Gender, to differentiate clearly between biological sex and gender identity, and to align naming to current practice throughout the country.

New Types

Domain Score SDTN Type, to allow the NAPLAN domain scores for a student to be published as part of the Student Data Transfer Note payload while allowing more elements to be optional than for the output of the National Assessment Platform (which the domain scores had been modelled for to date.)
Time Table Change Reason List Type and Time Table Change Reason Type, requested by Timetabling Solutions, to indicate the kinds of change to timetabling being published through the ScheduledActivity object.
Aggressive refactoring of XML Element + Attribute combinations into distinct types, in order to make conversion to PESC JSON and back more straightforward: results in new common types Activity Evaluation Type (from Activity), Calculation Rule Type (from AggregateStaticticInfo), Learning Resource Location Type (from Learning Resource), PictureSourceType (from PersonPicture), Duration Type (from common type Activity Time Type), Identity Assertion Type (from common type Identity Assertions Type), TypedIdRefType (for all RefIdType + @SIF_RefObject combinations).

New CodeSets

Added Time Table Change Type, requested by Timetabling Solutions, to indicate the kinds of change to timetabling being published through the ScheduledActivity object.

Additions to CodeSets

Added Federal Electorates—219, Hawke.

Removals/Deprecations from CodeSets

Deprecated Relationship to Student—03, Adoptive parent, in favour of Parent, requested by DET VIC.
Removed Federal Electorates—514, Stirling, abolished at the 2022 federal election.

Other Changes

Significant refactoring and debugging of OpenAPI version of standard, with fully validated OpenAPI 3.0.4 version, restricted to PESC JSON output, and OpenAPI 3.1.0 version, intended for online publishing.
Change to Relationship to Student—00, Spouse, updated to Spouse/Partner with annotation that it is expected to be rare, requested by DET VIC.
Demographics/Sex is redefined to mean biological sex; the use of the element to date to convey gender identity will henceforth be taken over by Demographics/Gender, in order to align naming to current practice.
Modelled Monetary Amount Type explicitly as an extension (i.e. an addition of an XML attribute to a pre-existing type), for better translation to PESC JSON.
Documentation added to TimeTable and ScheduledActivity objects, following proposal from Timetabling Solutions, on how to use ScheduledActivity to publish timetabling changes, including indicating the start date of the timetabling cycle.