Given name in Healthcare Worker API

Healthcare Worker API
1

https://digital.nhs.uk/developer/api-catalogue/healthcare-worker-fhir#get-/Practitioner

The docs given an example of a Practitioner given name as:

"given": [
    "Jane Allison"
]

Is this right? Why is it a list if the names are concatenated into one entry?

For example, my test user (555276865103) in the INT CIS2 LDAP has a givenName of Bob, and a nhsMiddleNames of DSAtestuser.
This is returned by the HCW API as:
“given”: [
“Bob DSAtestuser”
]
which is consistent with the docs, but means I have to do some hoop-jumping to separate the first and middle names and leaves me unsure of what I’ll get for users with multiple middle names.

I can deal with it, I just wanted to confirm the expected behaviour.

Thanks!

Bob

2

From my memory of testing it in INT, that’s how it works currently. But I agree it’s not great. I will see if we can change it, but I can’t guarantee when that would happen.

3

Would it be possible to support “text” in the name?

Most of the NHS organisations I’m working with tend to use the name in this format “SURNAME INITIALS” - I think this convention from NHS England via ODS.

Long term I’d like to use this API to lookup the detail of practitioners for us (NHS NW Genomics) and the other NHS organisations we are working with

4

@Kevin_Mayfield I don’t quite understand what you’re asking for. Can you elaborate?

5

@Bob_Walker This feature has made it onto our backlog. I’ve done the design but I can’t say when it will be delivered yet.

6

FHIR has text element which can hold the full name.

Screenshot 2026-06-12 at 18.39.03
Screenshot 2026-06-12 at 18.39.032194×858 157 KB

I hoping we will onboard to this API and use this API as the ‘master record’.

So when we use it our use will look something like this

"practitioner" : {
    "reference": "{optional} to healthcare worker API"
    "identifier" : {
      "system" : "https://fhir.hl7.org.uk/Id/gmc-number",
      "value" : "C3456789" <-- {Recommended}
    },
    "display" : "{mandatory} Dr Samuel Darwin" <- text from healthcare worker API???? This
  },

We don’t expect any of the Trusts or Laboratories to follow the link to SDS, ODS or this API. The display name and GMP/GMC is code is normally sufficient.

I can easily build this ourselves from Healthcare Worker API but would helpful it it was populated. We’re only doing this in HL7 FHIR e.g. PractitionerRole C3456789 Example - JSON Representation - NHS North West Genomics v2.0.8, in other standards e.g. V2 it’s mix of full and surname+given etc.