Service Agreement Notification Entities

Parent Previous Next

Service Agreement Entities

Is based on the entities used for the Telecare Referral and contains the following fields:


Notification Type

This will indicate the reason that the notification has been raised.  E.g.


Description

This field is optional and where used will contain additional data relating to the notification Type.  E.g. a Service Agreement Cancellation will have a Cancellation Reason associated with it and this will be used to populate the description field.


Id

This is a unique identifier for the Service Agreement and will be the same as the PayloadId used during submission of the Telecare Referral for this service user.


Service User

This is identical in structure to the Service User used in the Referral document.


Address

In this context this is synonymous with and will contain the same data as the address field of the Service User.  This field has been included to allow Tunstall to extend the use of this document to Service Agreements that do not relate to a Service User.  This use case is out of scope for HCC.


Devices

An array of Devices related to the Service Agreement.


Created On

The date/time that Tunstall accepted the Referral and created a Service Agreement.


Activated On

The date/time that the service provision described by Service Agreement was initiated.


Terminated On

The date/time that the Service Agreement was terminated.


Device

A device is a piece of equipment or other asset associated with the Service Agreement.  A device has the following fields:


Type

This indicates the general category of the device: e.g. Dispersed Unit, Scheme Module.


Manufacturer

The device manufacturer


Model

The device model


Id

A unique Id for the device, if available.  E.g. a serial number or programmed Id.

Created with the Personal Edition of HelpNDoc: Free EBook and documentation generator