6 Data Model

6.1 Introduction

This section presents the XML structure for SIF Data Model common elements and objects in a tabular format for readers less versed in parsing formal XML schema definitions, along with conventions that typically apply in the data model for easy reference.

6.1.1 Format

The Char(acteristics) column for all of the tables in this section use the following codes:

Code Characteristic
M Mandatory element or attribute
O Optional element or attribute
C Conditional element or attribute
MR Mandatory and repeatable element
OR Optional and repeatable element
CR Conditional and repeatable element

Mandatory elements MUST be present in Add events, and in non-empty and non-error responses to requests for entire SIF objects (e.g., no SIF_Query/SIF_QueryObject/SIF_Element elements supplied in the request). Mandatory attributes MUST always be present if their corresponding element is present.

SIF Agents and Zone Integration Servers MUST supply data according to the types specified in the Type columns and their corresponding equivalents in the most recent schema files associated with this specification. If there is a discrepancy between object and element definitions in this specification and the corresponding schema files, the definition in the schema files takes precedence; every effort will be made to note discrepancies in the errata for this document as they are identified.

6.1.2 Conventions

6.1.2.1 Object Attributes/Primary Keys

While XML attributes are primarily used in SIF to provide additional processing information regarding the associated element content, attributes at the root level of an object have special significance. These attributes serve as the primary key or identifier for the object; in many cases this is no more than a RefId GUID of RefIdType, though the primary key may consist solely of foreign key references to other SIF objects and include school years, dates, etc. These key attributes are immutable over the lifetime of an object and serve the purpose of uniquely identifying an object, especially in Change and Delete events. Some groups include non-primary key attributes in object attributes (e.g. mandatory foreign key references to other objects) and attributes that provide additional processing information regarding the objects. As SIF currently mandates that all object attributes be included in all messages, when a SIF Association working group or task force places a non-primary key attribute in the object's attribute definitions (typically out of historical query conventions), they are indicating that this value must still be accessible to systems in Change and, more notably, Delete events. All object attributes must be supplied to identify the object in Change and Delete events.

6.1.2.2 Object References

As stated elsewhere, SIF primarily uses GUIDs as object identifiers, primary keys, or RefIds. References to primary keys (foreign key references) follow certain conventions in SIF in most objects:

6.1.2.3 Lists/Repeatable Elements

To those accustomed with normalized relational databases, the SIF Data Model will appear to not be especially normalized, especially with regard to repeating groups of data not being separated into their own "tables," or in SIF's case, "objects" with primary/foreign keys to maintain the relationship. Bear in mind that SIF is not a format for storing data; it is a format for transmitting data asynchronously between disparate and distributed systems needing to share data for interoperability; the format this data takes in different systems can vary greatly, and the data related to any given "entity" may come from a variety of sources and systems. The goals of normalization—eliminating redundancy, organizing data efficiently, reducing inconsistencies, etc.—take on a different meaning in a message queuing system. Of primary importance is transmitting the data needed for interoperability in a minimum number of messages. The need to "join" together a great number of separate objects is kept to a minimum in SIF, as individual systems do not have access to all the data required and due to the asynchronous nature of SIF, any one of these systems may take a fair amount of time before returning data necessary for joins (SIF_ExtendedQuery has been developed to communicate a join to a single system that may have direct access to the all the data necessary to efficiently accomplish this task). It's one thing to make a separate request for a student's picture or enrollment information, another entirely to request every available phone number, address and e-mail address separately from the SIF Zone. As such, it is often the case in SIF that repeating data is stored directly in an object, rather than being separated out into a separate object.

Repeating data is very analogous to objects, though, within any given object. In SIF's Publish/Subscribe model, repeating elements in objects can be added to, changed in or deleted from an object, much like objects can be added to, changed in or deleted from a Zone. Within an existing object, all of these actions take place within a Change event, and repeating elements—if any exist initially—are first made available within an object in an Add event or can be obtained directly via requests. Repeatable elements are contained within a parent List element in most SIF objects whether or not they support events, e.g.:

<EmailList> <Email Type="Primary">contact@sifinfo.org</Email> <Email Type="Alternate1">info@sifinfo.org</Email> </EmailList>
Example 6.1.2.3-1: EmailList

Two types of list are currently defined in SIF, ActionList and List; both consist of a list container element and a single repeatable child element. Each type of list serves different needs and has associated conventions for communication and processing in the SIF Publish/Subscribe Model. List or ActionList is specified in the Type column in tables in this section for each list; when an ActionList the key, possibly compound, is also indicated in the Type column. ActionList key values must be unique within an instance of an ActionList.

6.1.2.3.1 ActionList

An ActionList has a key that uniquely identifies each child element within the list. This type of list is primarily used when it is desirable or necessary for systems to support or refer to a subset of the list, either due to functionally only being able to support a subset or because specifying a subset in Change events is more efficient than transmitting a whole list as in List. While one system may support the Primary and Alternate1 e-mail address types above, another may additionally support Alternate2 addresses. The second system is able to communicate the addition, change or deletion of an Alternate2 address without the first system inadvertently interpreting that to mean a student or staff member's Primary and Alternate1 addresses have been deleted.

Systems communicate the whole list as a cohesive unit consisting of the parent list container element and all child elements in an Add event; if the container is present with no child elements, the list is empty; the same is implied when an optional list is not present in an Add event. In a Change event, systems SHOULD only transmit those elements that have been added, changed or deleted. Deletion is not implied by the omission of a child element, but rather explicitly communicated with a SIF_Action attribute of Delete added to the deleted element, along with the element's key attribute(s)/element(s) at a minimum. An empty list in a Change event implies no changes have occurred in the list, as does the omission of the list. Systems storing ActionList data should set/replace/delete any existing values identified by primary keys in the Change event they support.

<EmailList> <Email Type="Primary">editor@sifinfo.org</Email> <Email Type="Alternate1" SIF_Action="Delete" /> </EmailList>
Example 6.1.2.3.1-1: Indicating a new value for the Primary e-mail address and deleting the Alternate1 address

A system that supports an Alternate2 e-mail makes no changes to its value for that address type.

6.1.2.3.2 List

While a unique, primary key may still be identifiable in its child elements, a List is used primarily when:

Lists are always transmitted as a cohesive unit consisting of the parent list container element and all child elements. If no child elements exist in the list, the list consists of the container element alone. Omission of an optional List in an Add event also implies no list items. In a Change event, omission of the List indicates no changes have been made; otherwise the parent container element and all child elements, if any, are included. Systems storing List data should replace all corresponding data in their systems when persisting the list; likewise when a change is made to one or more list items or when all items in the list are deleted, systems should send the whole list in a Change event.

<CountriesOfCitizenship> <CountryOfCitizenship>US</CountryOfCitizenship> <CountryOfCitizenship>DE</CountryOfCitizenship> </CountriesOfCitizenship>
Example 6.1.2.3.2-1: Indicating an updated list of country citizenships

A system that supports CountriesOfCitizenship updates its local data to reflect Australia and German citizenship.

6.1.2.4 Supported Optional Elements Without Values

Some agents follow the convention of supplying an optional element as empty (e.g. <BirthDate></BirthDate> or <BirthDate/> to indicate that the application supports the element, but that it currently has no value available within a given object. To allow for this convention within SIF—as in this example an empty string does not satisfy the xs:date type definition of BirthDate—all optional elements in SIF are defined as nillable [SCHEMA]. To satisfy type constraints on an element while still supplying an empty or "nil" value, agents MUST tag the element with a true value for the nil attribute from namespace http://www.w3.org/2001/XMLSchema-instance [SCHEMA] (e.g. <BirthDate xsi:nil="true"/> where the prefix xsi has been mapped to the namespace http://www.w3.org/2001/XMLSchema-instance), unless an empty value is valid with regard to the element's type definition, in which case supplying the nil attribute value of true is optional. See SIF and XML Namespaces for more details on namespaces, and SIF and XML Schema for more details on SIF's use of XML Schema.

6.1.2.5 Externally-Defined XML

Note that XML not defined within SIF does not necessarily support ad hoc omission of XML elements at will to conform with the conventions of the SIF Publish/Subscribe Model (where unchanged elements are typically omitted in Change events, and where non-key elements are often omitted in Delete events) or of the SIF Request/Response Model (where a subset of elements can be retrieved from objects with requests). If externally-defined XML occurs within a SIF data object, SIF conventions do not extend to that XML unless that XML is defined to accommodate SIF conventions; the XML, when transmitted, must only conform to any external definitions dictating its structure, if any. Applications should be prepared for the possibility of receiving whole externally-defined XML structures in Change events (regardless of how little or much of the external XML has changed) and possibly also Delete events, likewise in responses even when a subset of the XML structure's child elements may have explicitly been requested.

6.2 Common Elements

6.2.1 Address

This element contains address data

Address
Figure 6.2.1-1: Address Address Type Role Street Line1 Line2 Line3 Complex StreetNumber StreetPrefix StreetName StreetType StreetSuffix ApartmentType ApartmentNumberPrefix ApartmentNumber ApartmentNumberSuffix City StateProvince Country PostalCode GridLocation MapReference Type XCoordinate YCoordinate RadioContact
 Element/@AttributeCharDescriptionType
 AddressM

This element contains address data.

 
 
@TypeM

Code that defines the location of the address. Note: A subset of specific valid values for each instance in a data object may be listed in that object.

 
AUCodeSetsAddressTypeType
@RoleM

A facet of Address

 
AUCodeSetsAddressRoleType
 StreetM

The street element is a complex element and breaks the street down into several parts. (Allow for PO Box here)

 
 
 Street/Line1M

Address line 1.

 
xs:normalizedString
 Street/Line2O

Address line 2.

 
xs:normalizedString
 Street/Line3O

Address line 3.

 
xs:normalizedString
 Street/ComplexO

Name of the complex.

 
xs:normalizedString
 Street/StreetNumberO

The address number assigned to the building.

 
xs:normalizedString
 Street/StreetPrefixO

Street prefix like NE

 
xs:normalizedString
 Street/StreetNameO

The name of the street.

 
xs:normalizedString
 Street/StreetTypeO

The type of street. For example, Lane, Blvd., Ave., etc.

 
xs:normalizedString
 Street/StreetSuffixO

Street suffix like SW.

 
xs:normalizedString
 Street/ApartmentTypeO

Type of apartment, for example, Suite.

 
xs:normalizedString
 Street/ApartmentNumberPrefix
     
O

Apartment number prefix.

 
xs:normalizedString
 Street/ApartmentNumberO

The number of the apartment.

 
xs:normalizedString
 Street/ApartmentNumberSuffix
     
O

Apartment number suffix.

 
xs:normalizedString
 CityM

The city part of the address.

 
xs:normalizedString
 StateProvinceC

The state or province code. StateTerritory Code only applicable if an Australian Address. Conditional- If Australian Address this is mandatory.

 
StateProvince
 CountryO

The country code.

 
Country
 PostalCodeM

The ZIP/postal code.

 
xs:normalizedString
 GridLocationO

The location of the address.

 
GridLocation
 MapReferenceO

A Map Reference in x-y co-ordinates.

 
 
@TypeM

Type map reference

 
xs:normalizedString
 MapReference/XCoordinateM

X Co-ordinate of reference

 
xs:normalizedString
 MapReference/YCoordinateM

Y Co-ordinate of reference

 
xs:normalizedString
 RadioContactO

UHF Radio frequency or channel used for contact eg: 477MHz or CH60

 
xs:string
Table 6.2.1-1: Address
<Address Type="0123" Role="012B"> <Street> <Line1>1 IBM Plaza</Line1> <Line2>Suite 2000</Line2> <StreetNumber>1</StreetNumber> <StreetName>IBM</StreetName> <StreetType>Plaza</StreetType> <ApartmentType>Suite</ApartmentType> <ApartmentNumber>2000</ApartmentNumber> </Street> <City>Chicago</City> <StateProvince>IL</StateProvince> <Country>1101</Country> <PostalCode>60611</PostalCode> <GridLocation> <Latitude>41.850000</Latitude> <Longitude>-87.650000</Longitude> </GridLocation> </Address>
Example 6.2.1-1: Address

6.2.2 AddressList

A list of Address elements.

AddressList
Figure 6.2.2-1: AddressList AddressList Address SIF_Action
 Element/@AttributeCharDescriptionType
 AddressList 

A list of Address elements.

 
ActionList (Address/@Type, Address/@Role)
 AddressMR Address
@SIF_ActionO

In a Change event, this flag can be used to indicate an element has been deleted from the parent list container. At a minimum the key for the list must also be present.

 
values:
Delete
Table 6.2.2-1: AddressList
<AddressList> <Address Type="0123" Role="012B"> <Street> <Line1>1 IBM Plaza</Line1> <Line2>Suite 2000</Line2> <StreetNumber>1</StreetNumber> <StreetName>IBM</StreetName> <StreetType>Plaza</StreetType> <ApartmentType>Suite</ApartmentType> <ApartmentNumber>2000</ApartmentNumber> </Street> <City>Chicago</City> <StateProvince>IL</StateProvince> <Country>1101</Country> <PostalCode>60611</PostalCode> <GridLocation> <Latitude>41.850000</Latitude> <Longitude>-87.650000</Longitude> </GridLocation> </Address> </AddressList>
Example 6.2.2-1: AddressList

6.2.3 AttendanceCode

AttendanceCode
Figure 6.2.3-1: AttendanceCode AttendanceCode Code OtherCodeList
 Element/@AttributeCharDescriptionType
 AttendanceCode

Code that describes the absence/attendance.

 
 
 CodeM

Code representing the absence/attendance.

 
AUCodeSetsAttendanceCodeType
 OtherCodeListO OtherCodeList
Table 6.2.3-1: AttendanceCode
<AttendanceCode> <Code>200</Code> <OtherCodeList> <OtherCode Codeset="Local">S</OtherCode> <OtherCode Codeset="Other">C</OtherCode> </OtherCodeList> </AttendanceCode>
Example 6.2.3-1: AttendanceCode

6.2.4 BirthDate

A person's date of birth.

BirthDate
Figure 6.2.4-1: BirthDate BirthDate
 Element/@AttributeCharDescriptionType
 BirthDate 

A person's date of birth.

 
xs:date
Table 6.2.4-1: BirthDate
<BirthDate>1970-08-11</BirthDate>
Example 6.2.4-1: BirthDate

6.2.5 ContactInfo

Common element used to supply information for a contact person at a school, LEA, or other institution.

ContactInfo
Figure 6.2.5-1: ContactInfo ContactInfo Name PositionTitle Role Address EmailList PhoneNumberList
 Element/@AttributeCharDescriptionType
 ContactInfo 

Common element used to supply information for a contact person at a school, LEA, or other institution.

 
 
 NameM

 

Name
 PositionTitleO

The contact person's position title.

Examples
Superintendent

xs:normalizedString
 RoleO

Role played by this contact in this instance.

Examples
Report Contact
Primary Contact
Alternate Contact

xs:normalizedString
 AddressO

Address of the contact.

 
Address
 EmailListO

List of Email elements.

 
EmailList
 PhoneNumberListO

List of PhoneNumber elements.

 
PhoneNumberList
Table 6.2.5-1: ContactInfo
<ContactInfo> <Name Type="LGL"> <FamilyName>Woodall</FamilyName> <GivenName>Charles</GivenName> <MiddleName>William</MiddleName> </Name> <PositionTitle>Superintendent</PositionTitle> <EmailList> <Email Type="01">drseuss@whoville.k12.state.us</Email> </EmailList> <PhoneNumberList> <PhoneNumber Type="0096"> <Number>(02) 9555-0102</Number> </PhoneNumber> </PhoneNumberList> </ContactInfo>
Example 6.2.5-1: ContactInfo

6.2.6 Country

A country code.

Country
Figure 6.2.6-1: Country Country
 Element/@AttributeCharDescriptionType
 Country 

A country code.

 
union of:

AUCodeSetsStandardAustralianClassificationOfCountriesSACCType
Table 6.2.6-1: Country
<Country>1101</Country>
Example 6.2.6-1: Country

6.2.7 Demographics

Demographics information about the student, contact, staff member, etc.

Demographics
Figure 6.2.7-1: Demographics Demographics IndigenousStatus Sex BirthDate BirthDateVerification PlaceOfBirth StateOfBirth CountryOfBirth CountriesOfCitizenship CountryOfCitizenship CountriesOfResidency CountryOfResidency CountryArrivalDate AustralianCitizenshipStatus EnglishProficiency LanguageList DwellingArrangement Code Religion Code OtherCodeList ReligiousEventList ReligiousEvent Type Date ReligiousRegion PermanentResident VisaSubClass VisaStatisticalCode VisaExpiryDate ImmunisationCertificateStatus CulturalBackground
 Element/@AttributeCharDescriptionType
 Demographics 

Demographics information about the student, contact, staff member, etc.

 
 
 IndigenousStatusO

Whether or not the student identifies themselves as being of Aboriginal and/or Torres Strait Islander descent.

 
AUCodeSetsIndigenousStatusType
 SexO

'Sex' is the distinction 'male' and 'female', as reported by the person

 
AUCodeSetsSexCodeType
 BirthDateO

The person's date of birth.

 
BirthDate
 BirthDateVerificationO

Means by which the person's birth date was validated.

 
AUCodeSetsBirthdateVerificationType
 PlaceOfBirthO

The person's place of birth—like village, town, city etc.

 
xs:normalizedString
 StateOfBirthO

The person's state of birth.

 
StateProvince
 CountryOfBirthO

The person's country of birth.

 
Country
 CountriesOfCitizenshipO List
 CountriesOfCitizenship/CountryOfCitizenship
     
MR

A person's country of citizenship.

 
Country
 CountriesOfResidencyO List
 CountriesOfResidency/CountryOfResidency
     
MR

A person's country of residence.

 
Country
 CountryArrivalDateO

Date the person first arrived in the country.

 
xs:date
 AustralianCitizenshipStatusO

The person's citizenship status.

 
AUCodeSetsAustralianCitizenshipStatusType
 EnglishProficiencyOPerson's proficiency in English. EnglishProficiency
 LanguageListOList of languages an individual uses to communicate. LanguageList
 DwellingArrangementO

Setting/environment in which the person resides.

 
 
 DwellingArrangement/CodeM

Code representing the setting/environment in which the person resides

 
AUCodeSetsDwellingArrangementType
 ReligionO

Type of Religion if any

 
 
 Religion/CodeM

Religion Code

 
AUCodeSetsAustralianStandardClassificationOfReligiousGroupsASCRGType
 Religion/OtherCodeListO OtherCodeList
 ReligiousEventListO

List of Religious events

 
List
 ReligiousEventList/ReligiousEvent
     
OR

 

 
 ReligiousEventList/ReligiousEvent/
     Type
M

Religious Event - Currently Free Text

 
xs:normalizedString
 ReligiousEventList/ReligiousEvent/
     Date
M

Date of Religious Event

 
xs:date
 ReligiousRegionO

Belong to Religious Region - Currently Free Text.

 
xs:normalizedString
 PermanentResidentO

Australian Residency Status (Mandatory for Student)

 
AUCodeSetsPermanentResidentStatusType
 VisaSubClassO

Visa Sub-Class - Can be free text - not necessary to validate

 
AUCodeSetsVisaSubClassType
 VisaStatisticalCodeO

Visa Statistical Code - Can be free text - not necessary to validate

 
AUCodeSetsVisaStatisticalCodeType
 VisaExpiryDateO

Expiry Date of Visa if one exists

 
xs:date
 ImmunisationCertificateStatusO

Status of Immunisation Certificate

 
AUCodeSetsImmunisationCertificateStatusType
 CulturalBackgroundO

Used to indicate cultural background.

 
AUCodeSetsAustralianStandardClassificationOfCulturalAndEthnicGroupsASCCEGType
Table 6.2.7-1: Demographics
<Demographics> <IndigenousStatus>3</IndigenousStatus> <Sex>1</Sex> <BirthDate>1990-09-26</BirthDate> <BirthDateVerification>1004</BirthDateVerification> <PlaceOfBirth>Clayton</PlaceOfBirth> <StateOfBirth>VIC</StateOfBirth> <CountryOfBirth>1101</CountryOfBirth> <CountriesOfCitizenship> <CountryOfCitizenship>8104</CountryOfCitizenship> <CountryOfCitizenship>1101</CountryOfCitizenship> </CountriesOfCitizenship> <CountriesOfResidency> <CountryOfResidency>8104</CountryOfResidency> <CountryOfResidency>1101</CountryOfResidency> </CountriesOfResidency> <CountryArrivalDate>1990-09-26</CountryArrivalDate> <AustralianCitizenshipStatus>1</AustralianCitizenshipStatus> <EnglishProficiency> <Code>1</Code> </EnglishProficiency> <LanguageList> <Language> <Code>0001</Code> <LanguageType>1</LanguageType> </Language> </LanguageList> <DwellingArrangement> <Code>1671</Code> </DwellingArrangement> <Religion> <Code>2013</Code> </Religion> <ReligiousEventList> <ReligiousEvent> <Type>Baptism</Type> <Date>2000-09-01</Date> </ReligiousEvent> <ReligiousEvent> <Type>Christmas</Type> <Date>2009-12-24</Date> </ReligiousEvent> </ReligiousEventList> <ReligiousRegion>The Religion Region</ReligiousRegion> <PermanentResident>P</PermanentResident> <VisaSubClass>101</VisaSubClass> <VisaStatisticalCode>05</VisaStatisticalCode> </Demographics>
Example 6.2.7-1: Demographics Example

6.2.8 EducationalLevel

A code representing the highest level of education completed by a person.

EducationalLevel
Figure 6.2.8-1: EducationalLevel EducationalLevel
 Element/@AttributeCharDescriptionType
 EducationalLevel 

A code representing the highest level of education completed by a person.

 
AUCodeSetsSchoolEducationLevelTypeType
Table 6.2.8-1: EducationalLevel
<EducationalLevel>3</EducationalLevel>
Example 6.2.8-1: EducationalLevel

6.2.9 ElectronicId

Common element used to specify entity identifiers that are read by electronic equipment.

ElectronicId
Figure 6.2.9-1: ElectronicId ElectronicId Type
 Element/@AttributeCharDescriptionType
 ElectronicId 

Common element used to specify entity identifiers that are read by electronic equipment.

 
xs:normalizedString
@TypeM

Electronic ID type.

 
AUCodeSetsElectronicIdTypeType
Table 6.2.9-1: ElectronicId
<ElectronicId Type="01">206654</ElectronicId>
Example 6.2.9-1: ElectronicId

6.2.10 ElectronicIdList

A list of electronic identifiers associated with an entity.

ElectronicIdList
Figure 6.2.10-1: ElectronicIdList ElectronicIdList ElectronicId
 Element/@AttributeCharDescriptionType
 ElectronicIdList 

A list of electronic identifiers associated with an entity.

 
List
 ElectronicIdMR ElectronicId
Table 6.2.10-1: ElectronicIdList
<ElectronicIdList> <ElectronicId Type="01">206654</ElectronicId> <ElectronicId Type="03">1234</ElectronicId> </ElectronicIdList>
Example 6.2.10-1: ElectronicIdList

6.2.11 Email

This element represents an e-mail address of one of a number of types and occurs in objects such as StudentPersonal, StaffPersonal, StudentContactPersonal, etc.

Email
Figure 6.2.11-1: Email Email Type
 Element/@AttributeCharDescriptionType
 Email 

This element represents an e-mail address of one of a number of types and occurs in objects such as StudentPersonal, StaffPersonal, StudentContactPersonal, etc.

 
xs:normalizedString
@TypeM

This attribute specifies the type of e-mail address.

 
AUCodeSetsEmailTypeType
Table 6.2.11-1: Email
<Email Type="01">contact@sifinfo.org</Email>
Example 6.2.11-1: Email

6.2.12 EmailList

A list of e-mail addresses associated with an individual or organization.

EmailList
Figure 6.2.12-1: EmailList EmailList Email SIF_Action
 Element/@AttributeCharDescriptionType
 EmailList 

A list of e-mail addresses associated with an individual or organization.

 
ActionList (Email/@Type)
 EmailMR Email
@SIF_ActionO

In a Change event, this flag can be used to indicate an element has been deleted from the parent list container. At a minimum the key for the list must also be present.

 
values:
Delete
Table 6.2.12-1: EmailList
<EmailList> <Email Type="01">contact@sifinfo.org</Email> <Email Type="02">info@sifinfo.org</Email> </EmailList>
Example 6.2.12-1: EmailList

6.2.13 EnglishProficiency

EnglishProficiency
Figure 6.2.13-1: EnglishProficiency EnglishProficiency Code OtherCodeList
 Element/@AttributeCharDescriptionType
 EnglishProficiencyO  
 CodeM

Person's proficiency in English.

 
AUCodeSetsEnglishProficiencyType
 OtherCodeListO OtherCodeList
Table 6.2.13-1: EnglishProficiency
<EnglishProficiency> <Code>9</Code> </EnglishProficiency>
Example 6.2.13-1: EnglishProficiency

6.2.14 GraduationDate

Date student officially graduated from secondary education.

GraduationDate
Figure 6.2.14-1: GraduationDate GraduationDate
 Element/@AttributeCharDescriptionType
 GraduationDate 

Date student officially graduated from secondary education.

 
PartialDateType
Table 6.2.14-1: GraduationDate
<GraduationDate>2005-05-27</GraduationDate>
Example 6.2.14-1: GraduationDate

6.2.15 GridLocation

This element contains a map location. The GridLocation element is utilized within the Address element.

GridLocation
Figure 6.2.15-1: GridLocation GridLocation Latitude Longitude
 Element/@AttributeCharDescriptionType
 GridLocation 

This element contains a map location. The GridLocation element is utilized within the Address element.

 
 
 LatitudeM

Latitude in decimal degrees.

Latitudes north of the equator are positive, latitudes south of the equator are negative [ISO 6709].

 
xs:decimal
xs:minInclusive-90
xs:maxInclusive90
 LongitudeM

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
xs:minInclusive-180
xs:maxInclusive180
Table 6.2.15-1: GridLocation
<GridLocation> <Latitude>41.850000</Latitude> <Longitude>-87.650000</Longitude> </GridLocation>
Example 6.2.15-1: GridLocation

6.2.16 HomeroomNumber

Common element used to specify the locally-defined number or identifier for a homeroom. It is used in objects such as RoomInfo and StudentSnapshot.

HomeroomNumber
Figure 6.2.16-1: HomeroomNumber HomeroomNumber
 Element/@AttributeCharDescriptionType
 HomeroomNumber

Common element used to specify the locally-defined number or identifier for a homeroom. It is used in objects such as RoomInfo and StudentSnapshot.

 
xs:normalizedString
Table 6.2.16-1: HomeroomNumber
<HomeroomNumber>A-204</HomeroomNumber>
Example 6.2.16-1: HomeroomNumber

6.2.17 LanguageList

LanguageList
Figure 6.2.17-1: LanguageList LanguageList Language Code OtherCodeList LanguageType
 Element/@AttributeCharDescriptionType
 LanguageListO List
 LanguageMR  
 Language/CodeM

The code representing the specific language that an individual uses to communicate. 

 
AUCodeSetsAustralianStandardClassificationOfLanguagesASCLType
 Language/OtherCodeListO OtherCodeList
 Language/LanguageTypeO

An indication of the function and context in which an individual uses a language to communicate.

 
AUCodeSetsLanguageTypeType
Table 6.2.17-1: LanguageList
<LanguageList> <Language> <Code>1201</Code> <LanguageType>1</LanguageType> </Language> <Language> <Code>1301</Code> <LanguageType>9</LanguageType> </Language> </LanguageList>
Example 6.2.17-1: LanguageList

6.2.18 LifeCycle

This common metadata element describes the life cycle of the object it represents, based on the IEEE LOM LifeCycle element [LOM].

LifeCycle
Figure 6.2.18-1: LifeCycle LifeCycle Created DateTime Creators Creator Name ID ModificationHistory Modified By DateTime Description TimeElements TimeElement
 Element/@AttributeCharDescriptionType
 LifeCycle 

This common metadata element describes the life cycle of the object it represents, based on the IEEE LOM LifeCycle element [LOM].

 
 
 CreatedO When the object was created by whom. This is a more persistent creation date than the date/time in the object's SIF_Header. Depending on the use case being implemented, this value could contain the date the data in the object first entered the zone or was actually created.   
 Created/DateTimeM xs:dateTime
 Created/CreatorsO List
 Created/Creators/CreatorMR  
 Created/Creators/Creator/
     Name
M Human-readable name of the data's creator. If the object contains system-generated data, the name should identify the creating service or application.  xs:normalizedString
 Created/Creators/Creator/
     ID
MUnique identifier of the creator. An email address or URI could be used here. xs:normalizedString
 ModificationHistoryO An ordered set of Modified elements describing which system modified the data, when the modification took place, and a brief description of the modification.  List
 ModificationHistory/Modified
     
ORA single modification event.  
 ModificationHistory/Modified/
     By
MIdentifier of the system or person that modified the data. xs:normalizedString
 ModificationHistory/Modified/
     DateTime
MThe date/time the modification occurred. xs:dateTime
 ModificationHistory/Modified/
     Description
OHuman readable description of the data modifications. xs:string
 TimeElementsO List
 TimeElements/TimeElementOR TimeElement
Table 6.2.18-1: LifeCycle
<LifeCycle> <Created> <DateTime>2006-08-13T09:00:00-05:00</DateTime> <Creators> <Creator> <Name>Alphonse Berdonosi</Name> <ID>http://www.edugeeks.com/aberdonosi</ID> </Creator> </Creators> </Created> <ModificationHistory> <Modified> <By>http://www.edugeeks.com/aberdonosi</By> <DateTime>2006-08-17T09:30:00-05:00</DateTime> </Modified> </ModificationHistory> </LifeCycle>
Example 6.2.18-1: LifeCycle

6.2.19 LocalId

This is a common element used to define the locally assigned identifier associated with an entity.

LocalId
Figure 6.2.19-1: LocalId LocalId
 Element/@AttributeCharDescriptionType
 LocalId 

This is a common element used to define the locally assigned identifier associated with an entity.

 
xs:normalizedString
Table 6.2.19-1: LocalId
<LocalId>123321A</LocalId>
Example 6.2.19-1: LocalId

6.2.20 Location

This common element initially supports core data elements describing specific physical locations.

Location
Figure 6.2.20-1: Location Location Type LocationName LocationRefId SIF_RefObject
 Element/@AttributeCharDescriptionType
 Location   
@TypeO values:
Classroom
School
District
Campus
IntermediateUnit
StateEducationAgency
NonInstructionalSpace
AthleticVenue
Other
 LocationNameOName of the location. xs:token
 LocationRefIdO RefId of the location object if the location is a SIF Object such as SchoolInfo.  IdRefType
@SIF_RefObjectM Type of SIF Object Location points to.  values:
SchoolInfo
LEAInfo
RoomInfo
Table 6.2.20-1: Location
<Location Type="Classroom"> <LocationName>Beaconhills Middle School Library</LocationName> <LocationRefId SIF_RefObject="RooomInfo">947582610947583ACEB2BB345291BAAA</LocationRefId> </Location>
Example 6.2.20-1: Location

6.2.21 Name

The Name element, which could belong to a student, staff member, contact, etc. This element or a form with a subset of Type values occurs within objects such as StudentPersonal, StudentContactPersonal, StaffPersonal, etc.
Name
Figure 6.2.21-1: Name Name Type
 Element/@AttributeCharDescriptionType
 Name  The Name element, which could belong to a student, staff member, contact, etc. This element or a form with a subset of Type values occurs within objects such as StudentPersonal, StudentContactPersonal, StaffPersonal, etc.  BaseNameType
@TypeM

Code that specifies what type of name this is. If unsure, use LGL.

 
AUCodeSetsNameUsageTypeType
Table 6.2.21-1: Name
<Name Type="LGL"> <FamilyName>Woodall</FamilyName> <GivenName>Charles</GivenName> <MiddleName>William</MiddleName> </Name>
Example 6.2.21-1: Name

6.2.22 OnTimeGraduationYear

First projected graduation year, usually determined when student is accepted into 9th grade (CCYY).

OnTimeGraduationYear
Figure 6.2.22-1: OnTimeGraduationYear OnTimeGraduationYear
 Element/@AttributeCharDescriptionType
 OnTimeGraduationYear

First projected graduation year, usually determined when student is accepted into 9th grade (CCYY).

 
xs:gYear
Table 6.2.22-1: OnTimeGraduationYear
<OnTimeGraduationYear>2006</OnTimeGraduationYear>
Example 6.2.22-1: OnTimeGraduationYear

6.2.23 OperationalStatus

This common element contains status information an institution.

OperationalStatus
Figure 6.2.23-1: OperationalStatus OperationalStatus
 Element/@AttributeCharDescriptionType
 OperationalStatus 

Operational condition of an institution.

 
union of:

AUCodeSetsOperationalStatusType
Table 6.2.23-1: OperationalStatus
<OperationalStatus>O</OperationalStatus>
Example 6.2.23-1: OperationalStatus

6.2.24 OtherCodeList

List of other codes or strings that crosswalk to or serve as translations of the Code element paired with this common element. If Code changes and OtherCodes are supported, both Code and all associated OtherCode elements must be present.

OtherCodeList
Figure 6.2.24-1: OtherCodeList OtherCodeList OtherCode Codeset
 Element/@AttributeCharDescriptionType
 OtherCodeList 

List of other codes or strings that crosswalk to or serve as translations of the Code element paired with this common element. If Code changes and OtherCodes are supported, both Code and all associated OtherCode elements must be present.

 
List
 OtherCodeMR

A state/province code, local code, other code or a text string that crosswalks to or serves as a translation of an associated Code element.

 
xs:token
@CodesetM

Describes the OtherCode element content as either a state/province code, a local code, other code, or text string.

 
values:
StateProvince
Local
Other
Text
Table 6.2.24-1: OtherCodeList
<OtherCodeList> <OtherCode Codeset="Local">S</OtherCode> <OtherCode Codeset="Text">Semester</OtherCode> </OtherCodeList>
Example 6.2.24-1: OtherCodeList

6.2.25 OtherNames

Previous, alternate or other names or aliases associated with a person.

OtherNames
Figure 6.2.25-1: OtherNames OtherNames Name SIF_Action
 Element/@AttributeCharDescriptionType
 OtherNamesO

Previous, alternate or other names or aliases associated with a person.

 
ActionList (Name/@Type)
 NameMR

Name of the person. Note: Type value of LGL may not occur here.

 
OtherNameType
@SIF_ActionO

In a Change event, this flag can be used to indicate an element has been deleted from the parent list container. At a minimum the key for the list must also be present.

 
values:
Delete
Table 6.2.25-1: OtherNames
<OtherNames> <Name Type="AKA"> <FamilyName>Anderson</FamilyName> <GivenName>Samuel</GivenName> <FullName>Samuel Anderson</FullName> </Name> <Name Type="PRF"> <FamilyName>Rowinski</FamilyName> <GivenName>Sam</GivenName> <FullName>Sam Rowinski </FullName> </Name> </OtherNames>
Example 6.2.25-1: OtherNames

6.2.26 PersonInfo

PersonInfo
Figure 6.2.26-1: PersonInfo PersonInfo Name OtherNames Demographics AddressList PhoneNumberList EmailList
 Element/@AttributeCharDescriptionType
 PersonInfo 

 

 
 NameM

The name of the person. Note: Type attribute value of LGL must be used here.

 
NameOfRecordType
 OtherNamesO

Previous, alternate or other names or aliases associated with the person.

 
OtherNames
 DemographicsO

Demographic information about the person.

 
Demographics
 AddressListO

The person’s address(es).

 
AddressList
 PhoneNumberListO

The person’s phone number(s).

 
PhoneNumberList
 EmailListO

The person’s e-mail address(es).

 
EmailList
Table 6.2.26-1: PersonInfo
<PersonInfo> <Name Type="LGL"> <FamilyName>Smith</FamilyName> <GivenName>Fred</GivenName> <FullName>Fred Smith</FullName> </Name> <OtherNames> <Name Type="AKA"> <FamilyName>Anderson</FamilyName> <GivenName>Samuel</GivenName> <FullName>Samuel Anderson</FullName> </Name> <Name Type="PRF"> <FamilyName>Rowinski</FamilyName> <GivenName>Sam</GivenName> <FullName>Sam Rowinski </FullName> </Name> </OtherNames> <Demographics> <IndigenousStatus>3</IndigenousStatus> <Sex>1</Sex> <BirthDate>1990-09-26</BirthDate> <BirthDateVerification>1004</BirthDateVerification> <PlaceOfBirth>Clayton</PlaceOfBirth> <StateOfBirth>VIC</StateOfBirth> <CountryOfBirth>1101</CountryOfBirth> <CountriesOfCitizenship> <CountryOfCitizenship>8104</CountryOfCitizenship> <CountryOfCitizenship>1101</CountryOfCitizenship> </CountriesOfCitizenship> <CountriesOfResidency> <CountryOfResidency>8104</CountryOfResidency> <CountryOfResidency>1101</CountryOfResidency> </CountriesOfResidency> <CountryArrivalDate>1990-09-26</CountryArrivalDate> <AustralianCitizenshipStatus>1</AustralianCitizenshipStatus> <EnglishProficiency> <Code>1</Code> </EnglishProficiency> <LanguageList> <Language> <Code>0001</Code> <LanguageType>1</LanguageType> </Language> </LanguageList> <DwellingArrangement> <Code>1671</Code> </DwellingArrangement> <Religion> <Code>2013</Code> </Religion> <ReligiousEventList> <ReligiousEvent> <Type>Baptism</Type> <Date>2000-09-01</Date> </ReligiousEvent> <ReligiousEvent> <Type>Christmas</Type> <Date>2009-12-24</Date> </ReligiousEvent> </ReligiousEventList> <ReligiousRegion>The Religion Region</ReligiousRegion> <PermanentResident>P</PermanentResident> <VisaSubClass>101</VisaSubClass> <VisaStatisticalCode>05</VisaStatisticalCode> </Demographics> <AddressList> <Address Type="0123" Role="2382"> <Street> <Line1>Unit1/10</Line1> <Line2>Barkley Street</Line2> </Street> <City>Yarra Glenn</City> <StateProvince>VIC</StateProvince> <Country>1101</Country> <PostalCode>9999</PostalCode> </Address> <Address Type="0123A" Role="013A"> <Street> <Line1>34 Term Address Street</Line1> </Street> <City>Home Town</City> <StateProvince>WA</StateProvince> <Country>1101</Country> <PostalCode>9999</PostalCode> </Address> </AddressList> <PhoneNumberList> <PhoneNumber Type="0096"> <Number>03 9637-2289</Number> <Extension>72289</Extension> <ListedStatus>Y</ListedStatus> </PhoneNumber> <PhoneNumber Type="0888"> <Number>0437-765-234</Number> <ListedStatus>N</ListedStatus> </PhoneNumber> </PhoneNumberList> <EmailList> <Email Type="01">fsmith@yahoo.com</Email> <Email Type="02">freddy@gmail.com</Email> </EmailList> </PersonInfo>
Example 6.2.26-1: PersonInfo

6.2.27 PhoneNumber

This element represents a phone number and occurs within objects such as StudentPersonal, StaffPersonal, etc.

PhoneNumber
Figure 6.2.27-1: PhoneNumber PhoneNumber Type Number Extension ListedStatus
 Element/@AttributeCharDescriptionType
 PhoneNumber 

This element represents a phone number and occurs within objects such as StudentPersonal, StaffPersonal, etc.

 
 
@TypeM

Code that specifies what type of phone number this is. Note: A subset of valid values may be specified in data objects.

 
AUCodeSetsTelephoneNumberTypeType
 NumberM

Phone number. Free-form, but typical Australian formats include:

  • (###) ####-####
  • ####-####
  • +##### ### ###
 
xs:normalizedString
 ExtensionO

Phone number extension.

 
xs:normalizedString
 ListedStatusO

Indicates whether or not the phone number is available to the public.

 
AUCodeSetsYesOrNoCategoryType
Table 6.2.27-1: PhoneNumber
<PhoneNumber Type="0096"> <Number>(03) 9543 2000</Number> <Extension>245</Extension> </PhoneNumber>
Example 6.2.27-1: PhoneNumber

6.2.28 PhoneNumberList

Lists phone numbers associated with an entity.

PhoneNumberList
Figure 6.2.28-1: PhoneNumberList PhoneNumberList PhoneNumber SIF_Action
 Element/@AttributeCharDescriptionType
 PhoneNumberList 

Lists phone numbers associated with an entity.

 
ActionList (PhoneNumber/@Type)
 PhoneNumberMR PhoneNumber
@SIF_ActionO

In a Change event, this flag can be used to indicate an element has been deleted from the parent list container. At a minimum the key for the list must also be present.

 
values:
Delete
Table 6.2.28-1: PhoneNumberList
<PhoneNumberList> <PhoneNumber Type="0096"> <Number>(03) 9543 2000</Number> </PhoneNumber> </PhoneNumberList>
Example 6.2.28-1: PhoneNumberList

6.2.29 PrincipalInfo

Information about the campus or school principal.

PrincipalInfo
Figure 6.2.29-1: PrincipalInfo PrincipalInfo ContactName ContactTitle PhoneNumberList EmailList
 Element/@AttributeCharDescriptionType
 PrincipalInfoO

Information about the campus or school principal.

 
 
 ContactNameM

The name of the principal.

 
NameOfRecordType
 ContactTitleO

The principal's title.

 
xs:normalizedString
 PhoneNumberListO

The principal’s phone number(s).

 
PhoneNumberList
 EmailListO

The principal’s e-mail address(es).

 
EmailList
Table 6.2.29-1: PrincipalInfo
<PrincipalInfo> <ContactName Type="LGL"> <Title>Mr</Title> <FamilyName>Miller</FamilyName> <GivenName>James</GivenName> <MiddleName>Frank</MiddleName> <Suffix>Jr.</Suffix> <FullName>Mr James Frank Miller Jr.</FullName> </ContactName> <ContactTitle>School Principal</ContactTitle> <PhoneNumberList> <PhoneNumber Type="0096"> <Number>03 9637-2000</Number> <Extension>72345</Extension> <ListedStatus>Y</ListedStatus> </PhoneNumber> </PhoneNumberList> <EmailList> <Email Type="01">jmiller@lsc.vic.edu.au</Email> <Email Type="02">jmiller@yahoo.com.au</Email> </EmailList> </PrincipalInfo>
Example 6.2.29-1: PrincipalInfo

6.2.30 ProjectedGraduationYear

Currently projected graduation year.

ProjectedGraduationYear
Figure 6.2.30-1: ProjectedGraduationYear ProjectedGraduationYear
 Element/@AttributeCharDescriptionType
 ProjectedGraduationYear

Currently projected graduation year (CCYY).

 
xs:gYear
Table 6.2.30-1: ProjectedGraduationYear
<ProjectedGraduationYear>2006</ProjectedGraduationYear>
Example 6.2.30-1: ProjectedGraduationYear

6.2.31 PublishInDirectory

This is a common element used to specify whether or not information (e.g., contact information) should be published in a directory.

PublishInDirectory
Figure 6.2.31-1: PublishInDirectory PublishInDirectory
 Element/@AttributeCharDescriptionType
 PublishInDirectory

Indicates whether or not information should be published in a directory.

 
AUCodeSetsYesOrNoCategoryType
Table 6.2.31-1: PublishInDirectory
<PublishInDirectory>Y</PublishInDirectory>
Example 6.2.31-1: PublishInDirectory

6.2.32 Relationship

Code that defines the relationship of one person to another.

Relationship
Figure 6.2.32-1: Relationship Relationship Code OtherCodeList
 Element/@AttributeCharDescriptionType
 Relationship 

Code that defines the relationship of one person to another.

 
 
 CodeM

Code representing the relationship.

 
AUCodeSetsRelationshipToStudentType
 OtherCodeListO OtherCodeList
Table 6.2.32-1: Relationship
<Relationship> <Code>01</Code> </Relationship>
Example 6.2.32-1: Relationship

6.2.33 SchoolContactList

A list of contact persons associated with a school.

SchoolContactList
Figure 6.2.33-1: SchoolContactList SchoolContactList SchoolContact PublishInDirectory ContactInfo
 Element/@AttributeCharDescriptionType
 SchoolContactList 

A list of contact persons associated with a school.

 
List
 SchoolContactMR

Information on contact persons for this school.

 
 
 SchoolContact/PublishInDirectory
     
O

Indicates whether or not this school contact's information should be published in a directory of school information.

 
PublishInDirectory
 SchoolContact/ContactInfo
     
M ContactInfo
Table 6.2.33-1: SchoolContactList
<SchoolContactList> <SchoolContact> <PublishInDirectory>Y</PublishInDirectory> <ContactInfo> <Name Type="LGL"> <FamilyName>Woodall</FamilyName> <GivenName>Charles</GivenName> <MiddleName>William</MiddleName> </Name> <PositionTitle>Superintendent</PositionTitle> <EmailList> <Email Type="01">drseuss@whoville.k12.state.us</Email> </EmailList> <PhoneNumberList> <PhoneNumber Type="0096"> <Number>(08) 8555-0102</Number> </PhoneNumber> </PhoneNumberList> </ContactInfo> </SchoolContact> </SchoolContactList>
Example 6.2.33-1: SchoolContactList

6.2.34 SchoolURL

URL for a school.

SchoolURL
Figure 6.2.34-1: SchoolURL SchoolURL
 Element/@AttributeCharDescriptionType
 SchoolURL 

URL for a school.

 
xs:anyURI
Table 6.2.34-1: SchoolURL
<SchoolURL>http://www.lincolnhs.edu</SchoolURL>
Example 6.2.34-1: SchoolURL

6.2.35 SchoolYear

Common element used to designate the academic school year to which an object relates.

SchoolYear
Figure 6.2.35-1: SchoolYear SchoolYear
 Element/@AttributeCharDescriptionType
 SchoolYear

School year for which the information is applicable, expressed as the four-digit year in which the school year ends (e.g., "2009").

 
xs:gYear
Table 6.2.35-1: SchoolYear
<SchoolYear>2005</SchoolYear>
Example 6.2.35-1: SchoolYear

6.2.36 SIF_ExtendedElements

This element is supported at the end of all SIF objects. The element is used to extend existing SIF objects with locally-defined elements. Extended elements SHOULD NOT be used to duplicate data that can be obtained from other SIF objects.

SIF_ExtendedElements
Figure 6.2.36-1: SIF_ExtendedElements SIF_ExtendedElements SIF_ExtendedElement Name xsi:type SIF_Action
 Element/@AttributeCharDescriptionType
 SIF_ExtendedElements 

Allows an agent to include data not yet defined within a SIF data object as name/value pairs.

 
ActionList (SIF_ExtendedElement/@Name)
 SIF_ExtendedElementOR

A name/value pair, the name being contained in the Name attribute, the value being the element content.

 
ExtendedContentType
@NameM

The name of the extended element. As it is possible that names for extended elements may collide from agent to agent, it is recommended that the names of extended elements be configurable in an agent, or that agents use URIs for the names of extended elements.

 
xs:normalizedString
@xsi:typeO

Allows type of element to be explicitly communicated.

 
 
@SIF_ActionO

In a Change event, this flag can be used to indicate an element has been deleted from the parent list container. At a minimum the key for the list must also be present.

 
values:
Delete
Table 6.2.36-1: SIF_ExtendedElements
<SIF_ExtendedElements> <SIF_ExtendedElement Name="ApplicationSubmissionStatus">4</SIF_ExtendedElement> <SIF_ExtendedElement Name="DynamicXml"> <Parent xmlns="http://myapplication.com"> <Child n="1">one</Child> <Child n="2" /> <Child n="3">three</Child> </Parent> </SIF_ExtendedElement> <SIF_ExtendedElement Name="Note"> <xhtml:strong xmlns:xhtml="http://www.w3.org/1999/xhtml">Double</xhtml:strong>-check submission status. </SIF_ExtendedElement> </SIF_ExtendedElements>
Example 6.2.36-1: SIF_ExtendedElements

6.2.37 SIF_Metadata

Metadata is commonly referred to as data about data and includes information such as author, grade level, or keywords relating to a learning object, as examples. Metadata can be used to structure and contain any of this kind of information in a consistent manner. In the context of SIF, SIF_Metadata provides a consistent structure to appropriate SIF objects for the purpose of cataloging and object discovery, as well as other metadata functions and purposes. One recurring use case within the SIF data model is the requirement for some form of temporal constraints and tagging on objects (see TimeElement). Other metadata elements are based on needs brought to the Data Model Task Force.

IMPORTANT NOTE ON PERSISTENCE

This data is not designed to be permanent. It is designed to frame an object instance and could dissolve as soon as it leaves the SIF framework for the application space. A data warehouse could be used to store metadata for later tracking.

IMPORTANT NOTE ON USAGE

Any usage of metadata is optional unless made a requirement within individual SIF objects, or if a SIF or local profile or zone installation mandates it. SIF_Metadata allows for the usage of metadata in agents and applications that choose to support it.

This element is designed to operate much like SIF_ExtendedElements. It is an approved common element that is part of any data object.

SIF_Metadata
Figure 6.2.37-1: SIF_Metadata SIF_Metadata TimeElements TimeElement LifeCycle
 Element/@AttributeCharDescriptionType
 SIF_Metadata 

A commonly defined container for metadata elements defined within SIF.

 
 
 TimeElementsO List
 TimeElements/TimeElementOR TimeElement
 LifeCycleO LifeCycle
Table 6.2.37-1: SIF_Metadata

6.2.38 StateProvince

A state or province code. Note: When dealing with countries other than Australia, state/province codes/values other than those referenced here can be used.

StateProvince
Figure 6.2.38-1: StateProvince StateProvince
 Element/@AttributeCharDescriptionType
 StateProvince 

A state or province code. Note: When dealing with countries other than Australia, state/province codes/values other than those referenced here can be used.

 
union of:

AUCodeSetsStateTerritoryCodeType
xs:token
Table 6.2.38-1: StateProvince
<StateProvince>ACT</StateProvince>
Example 6.2.38-1: StateProvince

6.2.39 StateProvinceId

This is a common element used to define the state or province assigned identifier associated with an entity.

StateProvinceId
Figure 6.2.39-1: StateProvinceId StateProvinceId
 Element/@AttributeCharDescriptionType
 StateProvinceId

The identifier for this entity as assigned by the state or province.

 
xs:normalizedString
Table 6.2.39-1: StateProvinceId
<StateProvinceId>L65432765</StateProvinceId>
Example 6.2.39-1: StateProvinceId

6.2.40 SubjectArea

Subject matter.

SubjectArea
Figure 6.2.40-1: SubjectArea SubjectArea Code OtherCodeList
 Element/@AttributeCharDescriptionType
 SubjectArea 

Subject matter.

 
 
 CodeM

The subject area details

 
xs:normalizedString
 OtherCodeListO OtherCodeList
Table 6.2.40-1: SubjectArea
<SubjectArea> <Code>05</Code> <OtherCodeList> <OtherCode Codeset="Text">Graphic Arts</OtherCode> </OtherCodeList> </SubjectArea>
Example 6.2.40-1: SubjectArea

6.2.41 SubjectAreaList

A list of subject areas.

SubjectAreaList
Figure 6.2.41-1: SubjectAreaList SubjectAreaList SubjectArea
 Element/@AttributeCharDescriptionType
 SubjectAreaList 

A list of subject areas.

 
List
 SubjectAreaMR

Subject matter.

 
SubjectArea
Table 6.2.41-1: SubjectAreaList
<SubjectAreaList> <SubjectArea> <Code>05</Code> <OtherCodeList> <OtherCode Codeset="Text">Graphic Arts</OtherCode> <OtherCode Codeset="Local">GRA</OtherCode> </OtherCodeList> </SubjectArea> <SubjectArea> <Code>06</Code> <OtherCodeList> <OtherCode Codeset="Text">Visual Arts</OtherCode> </OtherCodeList> </SubjectArea> </SubjectAreaList>
Example 6.2.41-1: SubjectAreaList

6.2.42 TimeElement

A common metadata element designed to contain time data, both self-defined and by type.

TimeElement
Figure 6.2.42-1: TimeElement TimeElement Type Code Name Value StartDateTime EndDateTime SpanGaps SpanGap Type Code Name Value StartDateTime EndDateTime IsCurrent
 Element/@AttributeCharDescriptionType
 TimeElement 

A common metadata element designed to contain time data, both self-defined and by type.

 
 
 TypeM

This element is designed to contain the time period attached to an object. Very long periods (school year, quarter, etc.) and very small periods (second, millisecond, etc.) can be defined. This element provides a scoping description of the time metadata enclosed.

Because the educational environment varies so greatly we are including here a suggested but not prescriptive list of values. Although there may be unique needs for values not covered here—and we may have missed a major one—a best practice would be to utilize the examples here to enhance interoperability.

Examples
Full school year
Mini-term
Long session
Other
Semester
Trimester
Quarter
Spring Vacation
Summer Term
Intercession
Holiday

xs:normalizedString
 CodeM This element provides a place for the application to send structured data (code values, unique identifier, timestamps). This code value can, depending upon the use case agreement between agents, be used to qualify the data in the Value element.

Examples
2007SY
2006.FallConferences

xs:token
 NameM Contains a human-readable description of the value in Value.

Examples
Class of '07
Fall 2007 Parent-Teacher Conferences

xs:normalizedString
 ValueMContains the human-readable value.

Examples
2007
Evening of 10/12/06

xs:normalizedString
 StartDateTimeO xs:dateTime
 EndDateTimeO xs:dateTime
 SpanGapsOA container element for holding multiple possible span gaps. List
 SpanGaps/SpanGapOR This structure duplicates much of the structure of TimeElement and is designed to represent a gap in the parent time period defined by StartDateTime and EndDateTime above.   
 SpanGaps/SpanGap/TypeM xs:normalizedString
 SpanGaps/SpanGap/CodeM xs:token
 SpanGaps/SpanGap/NameM xs:normalizedString
 SpanGaps/SpanGap/ValueM xs:normalizedString
 SpanGaps/SpanGap/StartDateTime
     
O xs:dateTime
 SpanGaps/SpanGap/EndDateTime
     
O xs:dateTime
 IsCurrentM This element allows for the system to tag an object as being explicitly current. Although the baseline assumption in SIF is that objects are always current (default value is typically true), there are use cases when that is not the case.  xs:boolean
Table 6.2.42-1: TimeElement
<TimeElement> <Type>Full school year</Type> <Code>01</Code> <Name>2004/2005 School Year</Name> <Value>2004-2005</Value> <StartDateTime>2004-09-01T08:00:00-05:00</StartDateTime> <EndDateTime>2005-06-30T15:00:00-05:00</EndDateTime> <SpanGaps> <SpanGap> <Type>Holiday</Type> <Code>02</Code> <Name>2005 Winter Break</Name> <Value>2005 Winter Break</Value> <StartDateTime>2005-02-21T15:00:00-05:00</StartDateTime> <EndDateTime>2005-02-25T08:00:00-05:00</EndDateTime> </SpanGap> </SpanGaps> <IsCurrent>true</IsCurrent> </TimeElement>
Example 6.2.42-1: TimeElement

6.2.43 YearLevel

YearLevel
Figure 6.2.43-1: YearLevel YearLevel Code
 Element/@AttributeCharDescriptionType
 YearLevel

Year or academic level.

 
 
 CodeM

Code representing the year level.

 
AUCodeSetsYearLevelCodeType
Table 6.2.43-1: YearLevel
<YearLevel> <Code>8</Code> </YearLevel>
Example 6.2.43-1: YearLevel

6.2.44 YearLevels

List of year levels.

YearLevels
Figure 6.2.44-1: YearLevels YearLevels YearLevel
 Element/@AttributeCharDescriptionType
 YearLevels 

List of year levels.

 
List
 YearLevelMR YearLevel
Table 6.2.44-1: YearLevels
<YearLevels> <YearLevel> <Code>5</Code> </YearLevel> <YearLevel> <Code>6</Code> </YearLevel> <YearLevel> <Code>7</Code> </YearLevel> <YearLevel> <Code>8</Code> </YearLevel> </YearLevels>
Example 6.2.44-1: YearLevels

Valid XHTML 1.0 Transitional