AbsenceData

A full absence record data object which includes full patient demographic data.

Properties

Key

string

The key of the absence record.

Patient

PatientDemographicData

The patient’s demographic details.

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
  • 1 – Deleted
  • 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.

JSON Example

{
    "Patient": {
        "Title": "Mr",
        "Name": "John",
        "Surname": "Lemon",
        "SexType": 1,
        "Initials": "JL",
        "DateOfBirth": "1958-08-02T00:00:00",
        "Mobile": "+444 895 523 411",
        "Telephone": "+444 525 111 555",
        "EmailAddress": "<john.lemon@test.com>",
        "WorkEmailAddress": "<john.lemon@mywork.com>",
        "Address": {
            "Address1": "Studio 99",
            "Address2": "Backlok Street",
            "Address3": "Camden",
            "City": "London",
            "County": "",
            "PostCode": "N1 7NK",
            "Country": "United Kingdom"
        }
    },
    "Key": "efdc81efac0fd1a7f7b1833697a3ec3b",
    "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
}