Skip to main content

Digital Staff Passport onboarding and assurance

Find out how to complete our onboarding and assurance processes if you're integrating an external system with Digital Staff Passport.

Overview

If you are integrating an external system with Digital Staff Passport, you'll need to complete a number of onboarding and assurance checks before you can go live.

This applies to integrations using:

This page explains what you'll need to do.


Onboarding checklist

Contact us for a copy of the Digital Staff Passport onboarding checklist to complete.

For now, this is a spreadsheet. In due course we'll be using digital onboarding.


ODS code

The Organisation Data Service (ODS) holds details of all healthcare organisations, including developers. Each organisation in ODS has a unique ODS code - sometimes referred to as an Application Service Provider (ASP) code.

During the onboarding process, the ODS code you provide represents you as a developer onboarding a commercial product or as an end user organisation (EUO) developing a product in-house.

You'll need it to complete other steps in the onboarding process.

If you're not sure about your ODS code, you can:


Testing

We'll need to work together to perform functional and non-functional testing of the integration.

For details, see Digital Staff Passport integration testing.


Service level

During the pilot phase:

  • Digital Staff Passport is a bronze service, meaning it is operational and supported during business hours
  • your service level must be broadly in line our bronze service level

When we exit the pilot phase:

  • Digital Staff Passport will become a silver service, meaning it will be operational 24 hours a day, 365 days a year but only supported during business hours
  • your service level must be broadly in line with our silver service level

For more details, see service levels.


Incident management

You'll need to:

  • resolve incidents in line with the times specified for the appropriate service level
  • register with us to be able to raise incidents against Digital Staff Passport
  • provide us with a formal process for raising incidents against your system
  • participate in a 'dry run' exercise to test the end-to-end incident management processes

Live service monitoring

You'll need to:

  • pro-actively monitor your own service to make sure it's available
  • respond to any incidents in a timely manner as per the appropriate service level
  • let us know of any system outages by raising an incident with us
  • provide a way for us to pro-actively monitor your service availability (if you are following the API standard, do this by implementing the Get API status operation)

API connection terms

If you're implementing the Digital Staff Passport API standard, you'll need to sign the Digital Staff Passport API Connection Terms - this is a legal document that sets out the relevant obligations on both parties.

Last edited: 13 January 2025 10:20 am