BookProposedTimeSlot

Books and returns the new appointment from the given time slot. Returned appointment contains the amount owed by the patient.

JavaScript library method

patientportal.appointment.bookProposedTimeSlot({
    proposedTimeSlot: <proposedTimeSlot> ,
    clinician: <clinician>,
    clinicianSex: <clinicianSex>,
    method: <method>,
    price: <price>,
    patient: <patient>,
    referral: <referral>,
    recall: <recall>
});

HTTP Method

Verb	URL
POST	/patientportalapi/appointment/book-time-slot

URL Parameters

Parameter	Type	Description
patient	string (optional)	The key of the patient provided by the API upon section Patients. Used to book an appointment for a different patient within your company. Default is the logged in patient.
referral	string (optional)	The key of the referral provided by the API upon GetReferrals. Used to book an appointment for a specific referral.
recall	string (optional)	The key of the recall provided by the API upon method GetRecalls. Used to book an appointment for a specific recall.

POST Parameters

proposedTimeSlot	AppointmentData	The proposed time slot data, which can be constructed using the data provided by the GetProposedTimeSlots.
clinician	int (optional)	Clinician filter. Identifier provide by the API upon GetClinicians. Allow 0 for any clinician.
clinicianSex	int (optional)	Clinician’s gender filter: 0 = any sex 1 = male 2 = female
method	int (optional)	The method that will be used to determine which slot to select if multiple are found that match the given input criteria: 0 = random
price	decimal (optional)	Limit the bookable slots to only those that match the given price exactly

POST data example

{
    "proposedTimeSlot": {
        "Location": {
            "Key": 214
        },
        "Modules": [
            {
                "Key": 10382
            }
        ],
        "PayerType": "IN",
        "Services": [],
        "Site": {
            "Key": 1123
        },
        "Start": "2025-01-01T09:30:00",
        "Type": {
            "Key": "00000000fc0af8e9"
        }
    },
    "clinicianSex": 1,
    "method": 0,
    "price": 100
}

Returns

AppointmentData

Remarks

If no appropriate slot can be found for the proposed time slot, for example it was booked in the meantime, then an error is returned, see Error handling.