Create a referral

Sends a new referral into the EeRS

Create a new referral in the EeRS

Step 1: The cinician user decides to create a referral and clicks “refer via EeRS” or similar on the Optometry PMS system

Step 2: Optometry PMS gathers the data payload to send via the API

Step 3: Optometry PMS identifies the EeRS supplier API to call based on the optometry practice where the practitioner has clicked ‘create EeRS referral’

Step 4: Optometry PMS initiates API by sending API key to the EeRS in question with the data payload

Step 5: EeRS provides a response 201 with a URL - or an error message

Complete the referral in the EeRS

Step 1: Optometry PMS launches the URL for the user in a browser

Step 2: The user can now see the data rendered in the EeRS, and can complete the referral.

Step 3: The user completes the referral using the EeRS.

Optometry PMS sender guidance

If there is no value in your Optometry PMS for a non-mandatory nullable field do either one of the following: - exclude that field from the JSON - use JSON NULL to represent an empty field rather than empty string.

EeRS provider guidance

Any non-mandatory field will either be included as JSON null or not included at all from the sending Optometry PMS system. When saving a new referral initialise these fields to null in your system.