NHS Credential Management

Version 1.x of NHS Credential Management allows access to NHS CIS1 Authentication and CIS2 enabled applications via smartcards.

It does not directly authenticate with CIS2 and the authentication journey does require a Health and Social Care Network (HSCN) connection.

All workstations using CIS1 Authentication must have version 1.x of NHS Credential Management installed.

For a full list of compatible platforms, check the SPINE Warranted Environment Specification (WES).

Microsoft .NET 4.8 is the minimum .NET framework required.

NHS Credential Management is supported in environments like Citrix, VDI, and Terminal Services, including when users are performing Card Management services.

It also supports the use of EPS (Electronic Prescription Signing) via DSS (Digital Signing Service) only.

NHS Credential Management is required when using a smartcard with CIS1 or CIS2 Authentication. 

Previous versions, named NHS Identity Hub, are now deprecated and should be upgraded to the recommended NHS Credential Management version. 

Below, you’ll find all relevant versions and release notes for the NHS Credential Management that we recommend and support.

NHS England Credential Management v1.4.2.0 - recommended

Download NHS Credential Management v1.4.2.0 

SHA1 - ca36fd453e7cc3e9d34e6fd736c0b9db7ab091cf

MD5 - a65fd7803c7479d3c2e385374647bea7

NHS England Credential Management v1.3.1.0 - supported

Download NHS Credential Management v1.3.1.0 

SHA1 - dc1eb666bfb44cdd9079a93f0e52cda9fce0f216

MD5 - 3688d04e1b23bd10e51d78b0838791dc

1. Download the installer

• Go to the Download NHS Credential Management section. 

• Download the installer file.

2. Run the installer

• Navigate to the location where you downloaded the installer file. 

• Double-click the installer file to start the installation process. 

• The installer will open a setup wizard. 

• Follow the prompts, which typically include agreeing to the terms and conditions, choosing the installation directory, and, if applicable, selecting additional features or components to install. 

3. Complete the installation

• Once you've made your selections, click the Install button to begin the installation. 

• Wait for the installation process to complete. This may take a few minutes depending on the application size and your system's performance.

4. Launch the application

• After the installation is complete, you can find the application in your start menu or on your desktop. 

• Click on the application icon to open and start using it. 

Silent installation 

NHS Credential Management supports silent installation using standard deployment tools that recognise .msi packages. Alternatively, you can use the following command line for script-based installation: 

%SystemRoot%\System32\msiexec.exe /i "NHS.CredentialManagement.Setup-1.4.2.0.msi" /qn

NHS Port Service

As part of the NHS Credential Management installation, the NHS Port Service will be installed on a machine and will automatically start.

This service is required for NHS Credential Management to function correctly and should not be stopped or barred from executing.

Installation location

Software will be installed in the following locations: 

• C:\Program Files (x86)\NHS Digital\NHS Credential Management 

• C:\Program Files (x86)\NHS Digital\NHS Port Service 

Uninstall via Control Panel

1. Open the Control Panel

• Press the Windows key + S and type Control Panel. 

• Select Control Panel from the search results. 

2. Navigate to Programs and Features

• In the Control Panel, click on Programs. 

• Click on Programs and Features. 

3. Uninstall the application

• Scroll through the list of installed programs to find the version of NHS Credential Management you want to uninstall. 

• Select the application from the list. 

• Click on Uninstall at the top of the list. 

• Follow the prompts to complete the uninstallation process. 

Uninstall via Settings

1. Find the application to uninstall

• Press the Windows key + I to open Settings. 

• Go to Apps > Installed apps.

• Scroll through the list of installed applications to find the version of NHS Credential Management you want to uninstall. 

• Alternatively, you can use the search bar to quickly locate the application. 

2. Uninstall the application

• Click on the application. 

• Click on Uninstall and follow the prompts to complete the uninstallation process. 

Uninstall using Command Prompt 

1. Open Command Prompt as administrator

• Press the Windows key + R on your keyboard.
• In the Run dialog box, type “cmd” into the field and then press Ctrl + Shift + Enter. This will open Command Prompt with administrative privileges.

2. Use WMIC to uninstall

• Type the following command to list all installed applications: wmic product get name

• Find the name of the application you want to uninstall. 

• Type the following command to uninstall the application (replace your application name with the actual name of the application: wmic product where "name='your application name'" call uninstall

Launch the program

Once NHS Credential Management has been installed, an icon will be placed in the Programs | NHS Credential Management area of the Start Menu. On Windows 10 devices, an icon will also be placed on the Applications screen.

NHS Credential Management does not automatically start after installation but will automatically start on a subsequent user login or machine restart.

Close the program

An icon will be visible in the system tray when NHS Credential Management is running. The program can be closed by right clicking on this icon and selecting Close. Right clicking and selecting Status will show the currently installed version.

Log paths

NHS Credential Management logs can be found under the path below:

C:\Users\{username}\AppData\Local\HSCIC\NHSCredentialManagement

NHS Port Service logs can be found under the path below:

C:\ProgramData\HSCIC\NHS Port Service

To ensure Windows is configured correctly, follow these steps: 

1. Open Control Panel and navigate to: 

   • Internet Options > Security > Local Intranet > Sites 

(You can also search for 'Internet Options' in the Start menu to access this setting.) 

2. In the Internet Properties window, select the Local intranet tab, then the Sites button. 

   • Internet Properties - Local Intranet: 

     • Look for the following settings in the Local intranet dialog: 

       • Automatically detect intranet network should be unticked 

       • The following options should be ticked:

         • Include all local (intranet) sites not listed in other zones 

         • Include all sites that bypass the proxy server 

         • Include all network paths (UNCs)

If these settings match the above configuration, no further changes are required for NHS Credential Management to function properly. 

Group Policy settings 

Certain group policy settings in Chrome and Edge can block NHS Credential Management from working as expected. If this happens, you will see the following generic error:

NHS Credential Management Error: Not Installed or Running 

While there are other possible reasons for this error, if NHS Credential Management and the NHS Port Service are running and functionality works in one browser (for example Edge) but not in another (for example Chrome), it's worth looking at the Group Policy settings. 

Note: Changes to Group Policy settings must be made by your local IT team. 

Incorrect cookie settings in Chrome and Edge can also block NHS Credential Management. To function correctly, the browser must allow cookies for localhost.

The NHS Credential Management application and NHS Port Service allow all CIS applications to be accessed without the use of Java applets and from most modern browsers, including Edge and Chrome.

It is an additional component for end user machines, and will work alongside any existing NHS Identity Agent. It does not prevent anyone continuing to use Java applets and Internet Explorer if they want to.

Please note that these legacy setups are not supported, and this is included for information only.

Read more information on legacy setups (needs HSCN connection).

Get help with the most common issues with all versions of NHS Credential Management.

Registration Authority staff need NHS Credential Management to use the new Magicard 300 printer. This printer will not work without it.

It's also needed for any application that uses NHS CIS2 Authentication, such as Care Identity Management or sending invitations to register in Apply for Care ID.

NHS Credential Management v1.4.2.0 is required for series 9 smartcards.