AbsenceOverviewData

A full absence record data object which includes the patient’s full name.

Properties

Parameter Type Description
Key string The key of the absence record.
PatientName string The name of the patient.
StartDate DateTime The date that the absence started.
EstimatedEndDate DateTime The estimated return-to-work date.
EndDate DateTime (optional) The actual return-to-work date.
AbsenceStatusCode int

The status code of the absence record.

  • 0 – Open
  • 2– Closed
AbsenceStatusName string The name of the status code of the absence record, as specified in the AbsenceStatusCode.
QuestionnaireStatusCode int

The status code of the absence.

  • 0 – Not Sent
  • 1 – Sent
  • 2– Completed
QuestionnaireStatusName string

The name of the status code of the absence record’s questionnaire request, as specified in the QuestionnaireStatusCode.
LostWork LostWork The details about the amount of work lost due to the absence.
Reason string The name of the reason for the absence.
AccidentAtWork bool Whether the absence was a result of an accident in the workplace.
ReasonSharedWithEmployer bool Whether the reason for the absence is to be shared with the employer.
DepartmentName string The name of the employee department that the patient belongs to.
DivisionName string The name of the employee division that the patient belongs to.

JSON Example 

{
    "Key": "efdc81efac0fd1a7f7b1833697a3ec3b",
    "PatientName": "Vercruse, Katarina",
    "DepartmentName": "Support",
    "DivisionName": "Information Technology",
    "StartDate": "2018-06-11T00:00:00",
    "EstimatedEndDate": "2018-06-15T00:00:00",
    "EndDate": "2018-06-15T00:00:00",
    "AbsenceStatusCode": 2,
    "AbsenceStatusName": "Closed",
    "QuestionnaireStatusCode": 0,
    "QuestionnaireStatusName": "Not sent",
    "LostWork": {
        "Hours": 32,
        "Days": 4
    },
    "Reason": "Brain Tumour",
    "AccidentAtWork": false,
    "ReasonSharedWithEmployer": true
}