Using NHS login to create or retrieve GP credentials
If you are an IM1 supplier, you can learn how to use NHS login to create or retrieve GP credentials. This means users do not have to go their GP practice to register for your service.
This feature needs to be used as part of NHS login authentication. You cannot use NHS login as a one-off linkage key retrieval tool for GP credentials.
NHS login supports a scope of
gp_integration_credentials which will allow a relying party (RP) to retrieve the following user claims:
- Account ID
- ODS Code
- Linkage Key
These three pieces of information are required by IM1 paired services to create an IM1 token, which is then used by the RP to invoke the GP system patient facing APIs.
The RP (service) must be IM1 enabled to allow this scope in the production environment.
Retrieving these items of information via NHS login removes the need for the user to enter them manually. It also allows for the seamless registration of previously unregistered GP Online users, preventing the need to visit to a GP Practice.
This diagram illustrates:
- how NHS login processes a request from an RP for
gp_integration_credentialsvia the /userinfo endpoint
- how NHS login validates
gp_integration_credentialson each request and how
gp_integration_credentialsare refreshed if the information held by NHS login is invalid
GP integration credentials validation
gp_integration_credentials scope is requested by an RP, NHS login performs a background check of the validity of a stored IM1 token. As this check runs in the background asynchronously, it is the responsibility of the RP to also validate their IM1 token (if one exists).
If the RP determines that the claims returned from
gp_integration_credentials scope are not valid it can request refreshed claims from NHS login by re-starting the login process.
Optional: the RP can utilise the
asserted_login_identity request parameter to avoid the user needing to re-authenticate.
GP integration credentials are no longer valid
The GP credentials might no longer be valid due to:
- the user has moved GP surgery
- the GP surgery has changed GP systems
- GP surgeries merge / divide
- the user’s GP online access been revoked at the GP system
For example, a user's GP access may be revoked due to multiple failed login attempts. In cases 1, 2 and 3 generally the ODS code for the user changes. This will be detected by NHS login automatically via a separate background process, which validates PDS information relating to the user.
- When GP credentials (linkage keys) expire or are invalidated, all the IM1 tokens generated using them are also expired or invalidated. If the RP has any process to expire or invalidate the GP credentials (linkage keys) then it should be disclosed/discussed with NHS login.
- RP should cater for a user journey which prevents the user getting into an endless “retrieve GP credential” loop if the credentials genuinely can’t be retrieved.
GP systems coverage
The platforms that NHS login provides coverage for GP login credentials are:
- EMIS: 100%
- TPP: 100%
- Vision: 100% (250 in total)
- Microtest*: None (36 in total)
*GP login credentials (linkage keys) for Microtest returned by NHS login are dummy in nature, to maintain the uniform behaviour of the service. These GP login credentials cannot be used by RPs for connecting to Microtest.
Edit this page on GitHub