What you need before you start:

To use the Hub Testing Integration System (HITS), you’ll need the following:

You’ll also need a basic knowledge of SIF REST:

You need to know how to work with a use case in HITS and access the HITS API

If you get stuck: drop us a line at info@nsip.edu.au

How to implement third party Wellbeing Recording

1. What’s the business problem?

Allow schools to securely provide SIS information to the Wellbeing product(s) of their choice, and also to allow various wellbeing records to be published to a jurisdictional data hub.

More…

2. Use Case Description & Pre-Conditions

A 3rd Party Wellbeing application connects to HITS as a jurisdiction hub, collecting the relevant information and publishing back wellbeing records to the centralised system.

Wellbeing conceptual diagram

This conceptual diagram contains interactions beyond this specific technical use case, and is included for context.

Wellbeing recording SIF objects

Diagrams the interactions between SIF objects for this use case.

Assumptions:

3rd Party Vendor is a current supplier of a Wellbeing product in schools or has knowledge of Wellbeing reporting processes in K-12 Schools.

Pre-Conditions:

Here is the XSD schema for SIF 3.4.3.

3. Use case workflow

Workflow summary:

3.1. Join

3.2. Consume

3.3. Process

3.4. Provide

3.5. Assurance

3.1. Join required School Zone.

3.2. Consume Base Data from HITS.

Vendor-facing (pull); HITS represents the Jurisdiction and is the data source for seed information. Because of the complexity of the Wellbeing technical use case, not all seed information will be needed for all objects, and vendors who will not generate all Wellbeing objects may need only a subset of them; we indicate the dependencies between seed information and Wellbeing objects in the following.

Consume:

The following is a list of calls that need to be made to consume the required information:

  1. Get SchoolInfos - http://.../SchoolInfos  (HITS should determine the URLs eg http://hits.nsip.edu.au/SchoolInfos - access this information from your Dashboard.)
  2. Get StudentPersonals -  http://.../StudentPersonals (linked to school via StudentSchoolEnrollment; eg: equivalent to  http://.../SchoolInfo/\\{REFID}/StudentSchoolEnrollments/{REFID}/StudentPersonals)
  3. Get StaffPersonals -  http://.../StaffPersonals (linked to school via StaffAssignment; eg: equivalent to  http://.../SchoolInfo/\\{REFID}/StaffAssignments/{REFID}/StaffPersonals)
  4. Get StudentContactPersonals - http://.../StudentContactPersonals
  5. Get TimeTableSubjects -  http://.../TimeTableSubjects
  6. Get TimeTableCells -  http://.../TimeTableCells
  7. Get ScheduledActivitys -  http://.../ScheduledActivitys

Endpoints may support additional queries for retrieving data - refer to Query-by-example or service paths? for HITS guidance on queries.

3.3. Process in 3rd Party Application.

3rd Party App uses the consumed data to produce various types of wellbeing information. The definition and automation of this process is out of scope of HITS.

Steps:

3.4. Provide Authoritative Data

Prior to providing:  

  Third party expresses return information in SIF/XML:

3.5. Assurance: Self – Confirmation of Use Case Support

  1. Validate Wellbeing records

The SIF/XML data sent by the 3rd Party app to the Jurisdiction Zone for the app must satisfy the following conditions:

More…

More information…

What business problem does this use case address?

In brief:

Schools currently use third-party wellbeing applications locally to supplement their Student Information System (SIS). The seed information for recording of wellbeing is held in the School’s SIS and usually exported locally with little security.

As jurisdictions centralise systems, 3rd Party Vendors have the opportunity to seed their product/s from a quality assured data hub using automated feeds, rather than manual updates from the school. 3rd  Party Vendors are also expected to provide information directly back to the centralised system through an automated feed, rather than having the information mediated through the school. 

This use case shows how 3rd  party wellbeing vendors can connect to a centralised data hub to securely access to the required information and publish back Wellbeing records to the centralised data hub.

Use case preconditions for assurance

For the purposes of validation, a new Wellbeing object (PersonalisedPlan, WellbeingResponse, WellbeingEvent, WellbeingCharacteristic, WellbeingAppeal, WellbeingAppeal) is well-formed if it satisfies the following requirements:

Other business-specific rules for validation, including plausibility of any dates supplied, are not enforced by HITS.

Relevant Service Paths Supported on HITS

Relevant Queries By Example Supported on HITS

<SchoolInfo>
    <LocalId>{schoolCode}</LocalId>
</SchoolInfo>

<StudentPersonal>
  <LocalId>{id}</LocalId>
  <PersonInfo>
    <Name>
      <FamilyName>{familyName}</FamilyName>
      <GivenName>{givenName}</GivenName>
    </Name>
  </PersonInfo>
</StudentPersonal>

<StudentSchoolEnrollment>
  <TimeFrame>{type}</TimeFrame>
  <YearLevel><Code>{yearlevel}</Code></YearLevel>
</StudentSchoolEnrollment>

<TimeTableSubject>
  <SubjectLocalId>{id}</SubjectLocalId>
  <AcademicYear>{year}</AcademicYear>
  <AcademicYearRange><Start>{start}</Start><End>{end}</End></AcademicYearRange> <!-- TBD -->
  <SubjectShortName>{name}</SubjectShortName>
  <Semester>{semester}</Semester>
  <SchoolYear>{year}</SchoolYear>
</TimeTableSubject>

<TimeTableCell>
  <TimeTableRefId>{refId}</TimeTableRefId>
  <TeachingGroupRefId>{refId}</TeachingGroupRefId>
  <SubjectLocalId>{id}</SubjectLocalId>
</TimeTableCell>

<StaffPersonal>
    <LocalId>{eNumber}</LocalId>
</StaffPersonal>