Skip to main content

Part of Integration process overview

Stage 5 - Maintain

Current Chapter

Current chapter – Stage 5 - Maintain


Find out how to:

  • develop additional functionality post go-live
  • add additional customers or sites to a live solution
  • keep up-to-date with changes to the e-Referral Service API

5.1 Add new functionality to a live solution

Once you are in production, you can develop further functionality with our API.

If you are adding application-restricted endpoints for the first time, you should return to the build stage, step 2.1 Create and register your application and follow the process from there through to the end of Stage 4: Release.

If you are adding additional user-restricted or application-restricted endpoints, follow these steps:

5.11 Request new API endpoints

Return to the build stage, step 2.21 Integration testing, and complete the form. Include the additional endpoints you require and a use case to support your request.

Your form will be reviewed and feedback provided, if necessary.

5.12 Test your new software

Test your software in the integration environment, with the new added functionality.

5.13 Request the SCAL

Return to the build stage, step 2.52 Request and review the SCAL.

Request and review the SCAL.

This stage can be completed alongside step 5.11 Request new API endpoints.

5.14 Assure your additional endpoints

Once your use case is reviewed and you have submitted your SCAL you will go through assurance for your new endpoints.

On successful completion of this process a TCC will be issued to you. You will be required to embed the TCC in your SCAL and return to [email protected].

5.15 Confirm your connection agreement

Email the Live Services Onboarding (LSOB) team at [email protected] (cc [email protected]) to report the new capability in your application.

Confirm with the team if your connection agreement requires an update.

You be informed if your current connection agreement:

  • is adequate
  • requires an uplift

If an uplift is required, you will be sent an updated agreement to review, sign and return.

5.16 Go live

There are some further technical requirements for us to complete to ensure the new endpoints are added to your live application.

Once all the above activities are complete, the e-RS Partners team will email you to confirm your new site or customer is live.


5.2 Add a new site or customer to a live solution

Once your software is in the production environment, you can add additional sites or customers.

5.21 Contact the e-RS Partners team

Email [email protected] informing them of your intention to add a new site or customer. You will be sent a production environment form.

5.22 Send your AppID

Complete the production environment form sent to you by email and return it to [email protected].

5.23 Governance

If you have opted to use the application-restricted, unattended access mode, there are additional requirements you must be aware of and adhere to.

Review the End User Organisation responsibilities webpage. It is vital that this section of our documentation is read and understood by both yourself as the partner, as well as your customers or end user organisations. This includes the process to change the senior responsible person or ODS code.

Your new site/customer needs to complete the initial connection approval form.

This needs to be submitted to [email protected] including [email protected]

5.24 Go live

There are some further technical requirements for us to complete to ensure the new site or customer is added to your live application.

Once all the above activities are complete, the e-RS Partners team will email you to confirm your new site or customer is live.


5.3 Ongoing maintenance

It is imperative that partners keep up to date with API developments.

5.31 Patching

Partners must keep up to date with frameworks and libraries that may be used internally. This also extends to our API and its functionality.

This may mean a need to be re-assured from time to time, depending on your software changes.

5.32 Endpoint changes

We communicate all changes to partners ahead of time. 

You can follow our latest updates and plans for future development in our updates and releases section.

In order to keep up-to-date with the development of our API, you may need to make amendments or updates to your solution. You will be supported by the e-RS Partners team throughout this process.

5.33 SCAL changes

It is a contractual requirement that live partners ensure they are using the latest version of the SCAL. Partners may be asked to re-submit updated versions, even when live.


Last edited: 26 August 2025 9:19 am