SDS LDAP API - LDAP to FHIR mappings
Details of mappings from LDAP attributes to FHIR attributes for the SDS LDAP API and the various replacement FHIR APIs.
Overview
This page includes details of data attribute mappings from the SDS LDAP API to the various replacement FHIR APIs. The intended audience is software developers who are migrating away from the SDS LDAP API.
People branch
This section covers mappings from the SDS LDAP API to the following replacement APIs:
The following mappings table is wide - to see it all, scroll it horizontally.
| Logical name | LDAP attribute | HCW API attribute(s) | CIS2 Auth user info endpoint claim |
|---|---|---|---|
|
User’s Unique Identifier |
nhsPerson.Uid |
entry.resource[resourceType="Practitioner"].id entry.resource[resourceType="Practitioner"].identifier[system="https://fhir.nhs.uk/Id/sds-user-id"].value |
sub, uid, nhsid_useruid |
|
Full Name |
nhsPerson.Cn |
N/A (but can be constructed from name component fields) | name |
|
First Name |
nhsPerson.givenName |
entry.resource[resourceType="Practitioner"].name[0].given[0] | given_name |
|
Family Name |
nhsPerson.Sn |
entry.resource[resourceType="Practitioner"].name[0].family | family_name |
|
Middle Names |
nhsPerson.nhsMiddleNames |
entry.resource[resourceType="Practitioner"].name[0].given[1+] | middle_names |
|
Middle Initials |
nhsPerson.initials |
N/A | initials |
|
Preferred Full Name |
nhsPerson.displayName |
N/A | display_name |
|
Personal Title |
nhsPerson.personalTitle |
entry.resource[resourceType="Practitioner"].name[0].prefix | title |
|
Supplementary Prescriber |
nhsPerson.nhsSupPrescriber |
N/A | N/A |
|
Principal Occupation Code |
nhsPerson.nhsPrinOcc |
N/A | N/A |
|
RPSGB Membership Number |
nhsPerson.nhsRPSGB |
N/A | N/A |
|
General Medical Council Number |
nhsPerson.nhsGMC |
entry.resource[resourceType="Practitioner"].identifier[system="https://fhir.hl7.org.uk/Id/gmc-number"].value | gmc_id |
|
General Dental Practitioner Number |
nhsPerson.nhsGDP |
N/A | gdp_id |
|
General Dental Council Number |
nhsPerson.nhsGDC |
N/A | gdc_id |
|
Royal College of Nursing Number |
nhsPerson.nhsRCN |
N/A | rcn_id |
|
Nursing and Midwifery Council Number |
nhsPerson.nhsNMC |
N/A | nmc_id |
|
Consultant Code |
nhsPerson.nhsConsultant |
entry.resource[resourceType="Practitioner"].identifier[system="https://fhir.hl7.org.uk/Id/consultant-code"].value | consultant_id |
|
Doctor’s Index Number |
nhsPerson.nhsGMP |
entry.resource[resourceType="Practitioner"].identifier[system="https://fhir.hl7.org.uk/Id/din-number"].value | gmp_id |
|
NACS Practitioner Code |
nhsPerson.nhsOcsPrCode |
N/A | ocspr_code |
| General Pharmacy Council (GPhC) Number |
nhsPerson.nhsGPhC |
N/A | gphc_id |
|
Person Status |
nhsPerson.nhsPersonStatus |
entry.resource[resourceType="Practitioner"].active | N/A - only active records available |
|
Employee Passcode |
nhsPerson.nhsPuSecret |
N/A | N/A |
|
Telephone Identifier |
nhsPerson.nhsTelUid |
N/A | N/A |
|
Organisational Person Code |
nhsOrgPerson.uniqueIdentifer |
N/A | nhsid_org_memberships.person_orgid |
|
User’s Unique Identifier |
nhsOrgPerson.Uid |
entry.resource[resourceType="Practitioner"].id entry.resource[resourceType="Practitioner"].identifier[system="https://fhir.nhs.uk/Id/sds-user-id"].value |
sub, uid, nhsid_useruid |
|
Full Name |
nhsOrgPerson.Cn |
N/A (but can be constructed from name component fields) | name |
|
First Name |
nhsOrgPerson.givenName |
entry.resource[resourceType="Practitioner"].name[0].given[0] | given_name |
|
Family Name |
nhsOrgPerson.Sn |
entry.resource[resourceType="Practitioner"].name[0].family | family_name |
|
Middle Names |
nhsOrgPerson.nhsMiddleNames |
entry.resource[resourceType="Practitioner"].name[0].given[1+] | middle_names |
|
Middle Initials |
nhsOrgPerson.Initials |
N/A | initials |
|
Preferred Full Name |
nhsOrgPerson.displayName |
N/A | display_name |
|
NACS Organisation Name |
nhsOrgPerson.O |
entry.resource[resourceType="PractitionerRole"].organization.display |
nhsid_org_memberships.org_name Active organisation memberships only. |
|
NACS Organisation Code |
nhsOrgPerson.nhsIdCode |
entry.resource[resourceType="PractitionerRole"].organization.identifier.value |
nhsid_org_memberships.org_code Active organisation memberships only. |
|
NACS Site Name(s) |
nhsOrgPerson.nhsSiteNames |
N/A | N/A |
|
NACS Site Code(s) |
nhsOrgPerson.nhsSiteCodes |
N/A | N/A |
|
Department Code |
nhsOrgPerson.nhsDeptCodes |
N/A | N/A |
|
Roles |
nhsOrgPerson.nhsRoles |
entry.resource[resourceType="PractitionerRole"].code.coding.code |
nhsid_nrbac_roles.role_code |
|
Left Organisation |
nhsOrgPerson.nhsOrgCloseDate |
TBC |
N/A - only active records available |
|
General Medical Practitioner Code |
nhsOrgPerson.nhsGnc |
entry.resource[resourceType="PractitionerRole"].identifier[system="https://fhir.hl7.org.uk/Id/gmp-number"].value | gnc |
|
Joined Organisation |
nhsOrgPerson.nhsOrgOpenDate |
TBC |
N/A - only active records available |
|
Country |
nhsOrgPerson.nhsCountry |
N/A |
N/A |
|
Role Profile Code |
nhsOrgPersonRole.uniqueIdentifer |
entry.resource[resourceType="PractitionerRole"].identifier[system="https://fhir.nhs.uk/Id/sds-role-profile-id"].value |
nhsid_nrbac_roles.person_roleid |
|
NACS Organisation Code |
nhsOrgPersonRole.nhsIdCode |
entry.resource[resourceType="PractitionerRole"].organization.identifier.value |
nhsid_nrbac_roles.org_code |
|
Job Role Name |
nhsOrgPersonRole.nhsJobRole |
entry.resource[resourceType="PractitionerRole"].code.coding.display |
nhsid_nrbac_roles.role_name |
|
Job Role Code |
nhsOrgPersonRole.nhsJobRoleCode |
entry.resource[resourceType="PractitionerRole"].code.coding.code |
nhsid_nrbac_roles.role_code |
|
Area of Work Name |
nhsOrgPersonRole.nhsAreaofWork |
N/A |
nhsid_nrbac_roles.aow |
|
Area of Work Code |
nhsOrgPersonRole.nhsAreaofWorkCodes |
N/A |
nhsid_nrbac_roles.aow_codes |
|
Activity Name |
nhsOrgPersonRole.nhsBusinessFunctions |
TBC coming soon |
nhsid_nrbac_roles.activities |
|
Activity Code |
nhsOrgPersonRole.nhsBusinessFunctionsCodes |
TBC coming soon |
nhsid_nrbac_roles.activity_codes |
|
Work Group Name |
nhsOrgPersonRole.nhsWorkGroups |
N/A |
nhsid_nrbac_roles.workgroups |
|
Work Group Code |
nhsOrgPersonRole.nhsWorkGroupsCodes |
N/A |
nhsid_nrbac_roles.workgroups_codes |
|
Role Revoked |
nhsOrgPersonRole.nhsOrgCloseDate |
entry.resource[resourceType="PractitionerRole"].period.end |
N/A - only active records available |
|
Role Granted |
nhsOrgPersonRole.nhsOrgOpenDate |
entry.resource[resourceType="PractitionerRole"].period.start |
N/A - only active records available |
Services branch
This section covers mappings from the SDS LDAP API to Spine Directory Service - FHIR API.
The following mappings table is wide - to see it all, scroll it horizontally.
| Logical name | LDAP attribute | SDS FHIR API attribute(s) |
|---|---|---|
|
Accredited System Identifier |
nhsAS.uniqueIdentifier |
entry.resource.identifier[system="https://fhir.nhs.uk/Id/nhsSpineASID"].value |
|
Managing Organisation Code |
nhsAS.nhsIdCode |
N/A
|
|
Client Code |
nhsAS.nhsAsClient |
entry.resource.owner.identifier.value |
|
Party Key |
nhsAS.nhsMhsPartyKey |
entry.resource.identifier[system="https://fhir.nhs.uk/Id/nhsMhsPartyKey"].value |
|
ACF Characteristics |
nhsAS.nhsAsACF |
N/A |
|
Service Interactions |
nhsAS.nhsAsSvcIA |
entry.resource.extension[url="https://fhir.nhs.uk/StructureDefinition/Extension-SDS-NhsServiceInteractionId"].valueReference.identifier.value |
|
Description |
nhsAS.description |
N/A |
|
Category Bag |
nhsAS.nhsAsCategoryBag |
N/A |
|
Product |
nhsAS.nhsProductKey |
N/A |
|
Requestor’s Identity |
nhsAS.nhsRequestorURP |
N/A |
|
Date Requested |
nhsAS.nhsDateRequested |
N/A |
|
Approver’s Identity |
nhsAS.nhsApproverURP |
N/A |
|
Date Approved |
nhsAS.nhsDateApproved |
N/A |
|
MHS Manufacturer Organisation |
nhsAS.nhsMhsManufacturerOrg |
entry.resource.extension[url="https://fhir.nhs.uk/StructureDefinition/Extension-SDS-ManufacturingOrganisation"].valueReference.identifier.value |
|
MHS Identifier |
nhsMHS.uniqueIdentifier |
entry.resource.identifier[system="https://fhir.nhs.uk/Id/nhsMHSId"].value |
|
NACS Organisation Code |
nhsMHS.nhsIdCode |
entry.resource.managingOrganization.identifier.value |
|
Party Key |
nhsMHS.nhsMhsPartyKey |
entry.resource.identifier[system="https://fhir.nhs.uk/Id/nhsMhsPartyKey"].value |
|
Service-Interaction |
nhsMHS.nhsMhsSvcIA |
entry.resource.extension[url="https://fhir.nhs.uk/StructureDefinition/Extension-SDS-NhsServiceInteractionId"].valueReference.identifier.value |
|
Service Name |
nhsMHS.nhsMhsSN |
N/A |
|
Interaction Name |
nhsMHS.nhsMhsIN |
N/A |
|
End Point |
nhsMHS.nhsMhsEndPoint |
entry.resource.address |
|
CPA Identifier |
nhsMHS.nhsMhsCPAId |
entry.resource.identifier[system="https://fhir.nhs.uk/Id/nhsMhsCPAId"].value |
|
Is Authenticated |
nhsMHS.nhsMhsIsAuthenticated |
N/A |
|
Persist duration |
nhsMHS.nhsMhsPersistduration |
entry.resource.extension[url="https://fhir.nhs.uk/StructureDefinition/Extension-SDS-ReliabilityConfiguration"].extension[url="nhsMHSPersistDuration"].valueString |
|
Retries |
nhsMHS.nhsMhsRetries |
entry.resource.extension[url="https://fhir.nhs.uk/StructureDefinition/Extension-SDS-ReliabilityConfiguration"].extension[url="nhsMHSRetries"].valueString |
|
Retry Interval |
nhsMHS.nhsMhsRetryInterval |
entry.resource.extension[url="https://fhir.nhs.uk/StructureDefinition/Extension-SDS-ReliabilityConfiguration"].extension[url="nhsMHSRetryInterval"].valueString |
|
Sync Reply Mode |
nhsMHS.nhsMhsSyncReplyMode |
entry.resource.extension[url="https://fhir.nhs.uk/StructureDefinition/Extension-SDS-ReliabilityConfiguration"].extension[url="nhsMHSSyncReplyMode"].valueString |
|
Ack Requested |
nhsMHS.nhsMhsAckRequested |
entry.resource.extension[url="https://fhir.nhs.uk/StructureDefinition/Extension-SDS-ReliabilityConfiguration"].extension[url="nhsMHSAckRequested"].valueString |
|
Duplicate Elimination |
nhsMHS.nhsMhsDuplicateElimination |
entry.resource.extension[url="https://fhir.nhs.uk/StructureDefinition/Extension-SDS-ReliabilityConfiguration"].extension[url="nhsMHSDuplicateElimination"].valueString |
|
Actor |
nhsMHS.nhsMhsActor |
entry.resource.extension[url="https://fhir.nhs.uk/StructureDefinition/Extension-SDS-ReliabilityConfiguration"].extension[url="nhsMHSActor"].valueString |
|
FQDN of MHS |
nhsMHS.nhsMHSFQDN |
entry.resource.identifier[system="https://fhir.nhs.uk/Id/nhsMhsFQDN"].value |
|
IP Address of MHS |
nhsMHS.nhsMHSIPAddress |
N/A |
|
Network Connection |
nhsMHS.nhsMHSNetwork |
N/A |
|
SIN Code |
nhsMHS.nhsMHSSinCode |
N/A |
|
Product |
nhsMHS.nhsProductKey |
N/A |
|
Service Description |
nhsMHS.nhsMHSServiceDescription |
N/A |
|
Requestor’s Identity |
nhsMHS.nhsRequestorURP |
N/A |
|
Date Requested |
nhsMHS.nhsDateRequested |
N/A |
|
Approver’s Identity |
nhsMHS.nhsApproverURP |
N/A |
|
Date Approved |
nhsMHS.nhsDateApproved |
N/A |
|
DNS Approver’s Identity |
nhsMHS.nhsDNSApprover |
N/A |
|
Date DNS Approved |
nhsMHS.nhsDateDNSApproved |
N/A |
|
Interaction Type |
nhsMHS.nhsEPInteractionType |
N/A |
|
Contract Property Template |
nhsMHS.nhsContractPropertyTemplateKey |
N/A |
Organisations branch
For mappings to the Organisation Data Terminology FHIR API, contact us.
Last edited: 23 September 2026 12:13 pm