URPID for PDS - what is it?

hello

i’m working on integrating CIS2 and PDS (healthcare worker access) into our web application

the PDS docs at https://digital.nhs.uk/developer/api-catalogue/personal-demographics-service-fhir/pds-fhir-technical-conformance---healthcare-worker-access-mode mentions passing the URPID. however, i cannot find any other reference to this in the docs

the CIS2 docs at https://digital.nhs.uk/services/care-identity-service/applications-and-services/cis2-authentication/guidance-for-developers/detailed-guidance/scopes-and-claims mentions 2 possibly relevant scopes: selectedperson and nationalrbacaccess

do i need to be getting the person_roleid claim from nationalrbacaccess scope and passing this as the URPID, or something else? if so, is this value always available for NHS users?

thanks in advance for any guidance

User Role Profile ID.
From the National RBAC

If you are integrated with CIS2 Auth, you can force role selection using selected_role or changed_role scopes.

When you use HCW Access Mode, the user id and role id will be available to you

The userinfo from CIS2 Auth will list you all their roles. The selected_roleid from teh CIS2 Auth ID token is the role id.

See the “standards approach” on User-restricted RESTful APIs - CIS2 separate authentication and authorisation - NHS England Digital

2 Likes