RegisterPatient

Prepares a new registration. The patient is not fully created within the system until the appointment is booked.

JavaScript library method

patientportal.anonBooking.registerPatient({
    payerType: <payerType>,
    demog: <demog>
});

HTTP Method

Verb URL
POST /patientportalapi/anon-booking/register-patient

POST Parameters

Parameter Type Description
payerType string (optional)

The signup code of a chargeband, that will provide eligibility and price information for the search.

This is the same payer type like the one provided into the slot search GetProposedAppointments

demog PersonDemographicData

Person demographics. Mandatory fields are:

  • Name
  • Surname
  • EmailAddress
  • Mobile
  • DateOfBirth
    • based on DateOfBirthRequiredForPatients in GetConfig

Returned JSON

{
    "SessionId": "R9I8Dr8rGQcQ6EOfxVyOBX2r8zt4KTO06vW0O2+GyFc="
}

Remarks

A 2FA email and SMS message are automatically sent to the patient.