ReferralOverviewData

Provides overview information about the referral.

Properties

Parameter	Type	Description
Key	string	The key of the referral.
PatientName	string	The name of the patient.
PatientKey	string	The key of the patient.
ReferredBy	string	The name of the referrer.
CreatedDate	string	Created date.
ModifiedDate	string	Last modification date.
State	string	The state of the referral: QuestionnaireRequired – the referral questionnaire hasn’t been finished. AttachDocuments – the referral hasn’t been sent. The user may attach documents and send the referral. InProgress – the referral in progress. No user action is needed. Completed – the referral is completed. The list of states is not complete. There may be also another states.
StateDisplayName	string	The friendly name of the state.
StateColor	string	The color of the state.
IsFollowUp	bool	The referral is a follow up for the previous referral.
HasFollowUp	bool	The referral has a follow up referral.
PreviousReferralKey	bool	The key of the previous referral if IsFollowUp is true.
NextReferralKey	bool	The key of the next referral if HasFollowUp is true.
SLARequired	bool	True if the SLA has been required for the referral.
SLAFailed	bool	True if the SLA has failed for this referral.
SLAFailedReason	string	The reason why SLA failed.
ReferralNumber	string	The number of the referral.
AppointmentType	AppointmentTypeData	The type of the referral.
AbsenceRecordKey	string	The key of the absence record the referral is joined to.
DaysToReviewDischargeLetterByPatient	int	The number of days a patient has to review the referral discharge letter.

JSON Example

{
    "Key": "R123",
    "PatientName": "Mr. John Smith",
    "ReferredBy": "Mr. Will Smith",
    "CreatedDate": "2015-03-13T14:22:12",
    "ModifiedDate": "2015-03-13T14:52:30",
    "State": "InProgress",
    "StateDisplayName": "In progress",
    "StateColor": "green",
    "SLARequired": true,
    "SLAFailed": true,
    "SLAFailedReason": "The appointment was not placed within the SLA (5 days): Patient cannot meet SLA.",
    "ReferralNumber": 13911,
    "AppointmentType": {
        "Name": "Referral",
        "Key": "REF1",
        "Notes": "",
        "CanBookAppointment": true,
        "CanReferPatient": true
    },
    "DaysToReviewDischargeLetterByPatient": 3
}