NHS Digital FHIR Implementation Guide

• Combined
• Differential
• Constraints
• Examples

Practitioner

Practitioner.identifier

{
  "resourceType": "Practitioner",
  ...
  "identifier": [
          {
            "system": "https://fhir.nhs.uk/Id/sds-user-id",
            "value": "3415870201"
          },
          {
            "system": "https://fhir.hl7.org.uk/Id/gmp-number",
            "value": "G1234567"
          },
          {
            "system": "https://fhir.hl7.org.uk/Id/din-number",
            "value": "123456"
          }
        ]
  ...
}

{
  "resourceType": "Practitioner",
  ...
  "identifier": [
          {
            "system": "https://fhir.nhs.uk/Id/sds-user-id",
            "value": "1415870201"
          },
          {
            "system": "https://fhir.hl7.org.uk/Id/gmc-number",
            "value": "C2134567"
          }
        ]
  ...
}

{
  "resourceType": "Practitioner",
  ...
  "identifier": [
          {
            "system": "https://fhir.nhs.uk/Id/sds-user-id",
            "value": "1415870201"
          },
          {
            "system": "https://fhir.hl7.org.uk/Id/professional-code",
            "value": "2134567"
          }
        ]
  ...
}

Practitioner.identifier:gmcCode

Practitioner.identifier:gmcCode.system

https://fhir.hl7.org.uk/Id/gmc-number

Practitioner.identifier:gmpCode

Practitioner.identifier:gmpCode.system

https://fhir.hl7.org.uk/Id/gmp-number

Practitioner.identifier:dinCode

Practitioner.identifier:dinCode.system

https://fhir.hl7.org.uk/Id/din-number

Practitioner.identifier:gphcCode

Practitioner.identifier:gphcCode.system

https://fhir.hl7.org.uk/Id/gphc-number

Practitioner.identifier:hcpcNumber

Practitioner.identifier:hcpcNumber.system

https://fhir.hl7.org.uk/Id/hcpc-number

Practitioner.identifier:nmcNumber

Practitioner.identifier:nmcNumber.system

https://fhir.hl7.org.uk/Id/nmc-number

Practitioner.identifier:professionalNumber

Practitioner.identifier:professionalNumber.system

https://fhir.hl7.org.uk/Id/professional-code

Practitioner.identifier:gmcReferenceNumber

Practitioner.identifier:gmcReferenceNumber.system

https://fhir.hl7.org.uk/Id/gmc-reference-number

Practitioner.identifier:sdsUserId

Practitioner.identifier:sdsUserId.system

https://fhir.nhs.uk/Id/sds-user-id

Practitioner.name

Practitioner.telecom

Practitioner.telecom.value

Practitioner.telecom.use

Practitioner

Practitioner.identifier

{
  "resourceType": "Practitioner",
  ...
  "identifier": [
          {
            "system": "https://fhir.nhs.uk/Id/sds-user-id",
            "value": "3415870201"
          },
          {
            "system": "https://fhir.hl7.org.uk/Id/gmp-number",
            "value": "G1234567"
          },
          {
            "system": "https://fhir.hl7.org.uk/Id/din-number",
            "value": "123456"
          }
        ]
  ...
}

{
  "resourceType": "Practitioner",
  ...
  "identifier": [
          {
            "system": "https://fhir.nhs.uk/Id/sds-user-id",
            "value": "1415870201"
          },
          {
            "system": "https://fhir.hl7.org.uk/Id/gmc-number",
            "value": "C2134567"
          }
        ]
  ...
}

{
  "resourceType": "Practitioner",
  ...
  "identifier": [
          {
            "system": "https://fhir.nhs.uk/Id/sds-user-id",
            "value": "1415870201"
          },
          {
            "system": "https://fhir.hl7.org.uk/Id/professional-code",
            "value": "2134567"
          }
        ]
  ...
}

Practitioner.identifier:gmcCode

Practitioner.identifier:gmcCode.system

https://fhir.hl7.org.uk/Id/gmc-number

Practitioner.identifier:gmpCode

Practitioner.identifier:gmpCode.system

https://fhir.hl7.org.uk/Id/gmp-number

Practitioner.identifier:dinCode

Practitioner.identifier:dinCode.system

https://fhir.hl7.org.uk/Id/din-number

Practitioner.identifier:gphcCode

Practitioner.identifier:gphcCode.system

https://fhir.hl7.org.uk/Id/gphc-number

Practitioner.identifier:hcpcNumber

Practitioner.identifier:hcpcNumber.system

https://fhir.hl7.org.uk/Id/hcpc-number

Practitioner.identifier:nmcNumber

Practitioner.identifier:nmcNumber.system

https://fhir.hl7.org.uk/Id/nmc-number

Practitioner.identifier:professionalNumber

Practitioner.identifier:professionalNumber.system

https://fhir.hl7.org.uk/Id/professional-code

Practitioner.identifier:gmcReferenceNumber

Practitioner.identifier:gmcReferenceNumber.system

https://fhir.hl7.org.uk/Id/gmc-reference-number

Practitioner.identifier:sdsUserId

Practitioner.identifier:sdsUserId.system

https://fhir.nhs.uk/Id/sds-user-id

Practitioner.name

Practitioner.telecom

Practitioner.telecom.value

Practitioner.telecom.use

Definition

A person who is directly or indirectly involved in the provisioning of healthcare.

Constraints

• prac-nmc (WARNING) NMC must be of the format NNANNNNA

• prac-gmp (WARNING) GMP must be of the format GNNNNNNN and not be a spurious code (starts with G6 or G7)

• prac-gmc (WARNING) GMC must be of the format CNNNNNNN

• prac-gphc (WARNING) GPHC must be of the format NNNNNNN

• prac-gmcreferencenumber (ERROR) GMC Reference Number must be of the format NNNNNNN

• prac-hcpc (WARNING) HCPC must be of the format AANNNNNN

• prac-din (WARNING) DIN format must be NNNNNN

• prac-sds-user-numeric (ERROR) sds-user-id must be numeric

• nacs-code-retired (WARNING) NACS (/ODS) Practitioner Identifier is retired in NHS FHIR and should not be used. Please use the actual naming system instead (e,g, https://fhir.hl7.org.uk/Id/gmc-number, https://fhir.hl7.org.uk/Id/gmp-number, etc).

• identifier

• identifier:gmcCode

• identifier:gmcCode.system

• identifier:gmpCode

• identifier:gmpCode.system

• identifier:dinCode

• identifier:dinCode.system

• identifier:gphcCode

• identifier:gphcCode.system

• identifier:hcpcNumber

• identifier:hcpcNumber.system

• identifier:nmcNumber

• identifier:nmcNumber.system

• identifier:professionalNumber

• identifier:professionalNumber.system

• identifier:gmcReferenceNumber

• identifier:gmcReferenceNumber.system

• identifier:sdsUserId

• identifier:sdsUserId.system

• name

• telecom

identifier

Definition

SHOULD contain a professional code.

The inclusion of a professional code is strongly recommended. For consultants and doctors a prescribing code should be present. Please see NHS Data Model and Dictionary for details on these code.

The SDS User Id should be sourced from NHS Identity (SmartCard), this is also held within the Spine Directory Service LDAP database.

Format

• N = any number
• A = any alpha

(*) NHS Prescription Services systems require these prescriber codes to be 8 characters long. Additional zeroes (0) should be inserted immediately following the first 2 alpha characters to extend the code to 8 characters as necessary.

The Doctor Index Number (DIN) will be present in the resource even if they are prescribing using a different prescribing code. This code is called the spurious code is held within the NHSDigital-PractitionerRole resource and MUST NOT be contained in the Practitioner resource.

In the example below, the practitioner (GP as they have a GMP Code) has a SDS User Id of 3415870201, GMP code of G1234567 and DIN code of 123456. If the GP was in a role, prescribing using a spurious code this would be found in the PractitionerRole.

{
  "resourceType": "Practitioner",
  ...
  "identifier": [
          {
            "system": "https://fhir.nhs.uk/Id/sds-user-id",
            "value": "3415870201"
          },
          {
            "system": "https://fhir.hl7.org.uk/Id/gmp-number",
            "value": "G1234567"
          },
          {
            "system": "https://fhir.hl7.org.uk/Id/din-number",
            "value": "123456"
          }
        ]
  ...
}

In the example below, the practitioner (Consultant as they have a GMC Code) has a SDS User Id of 1415870201, GMC code of C2134567.

{
  "resourceType": "Practitioner",
  ...
  "identifier": [
          {
            "system": "https://fhir.nhs.uk/Id/sds-user-id",
            "value": "1415870201"
          },
          {
            "system": "https://fhir.hl7.org.uk/Id/gmc-number",
            "value": "C2134567"
          }
        ]
  ...
}

Professional Code System (Unspecified/Unknown System)

In cases where the profession code is present but it is not certain what type of code this is, the https://fhir.hl7.org.uk/Id/professional-code system should be used. It is also used for backwards compatibilty with EPS HL7 v3 ODS/NACS Practitioner Identifiers. This system may include codes from different codes and this may lead to identfication issues, for example GPhC and GMC Reference Number have the same format (7 digits), if one of these is receieved it is not known if this is a doctor and or a pharmacist.

E.g. in the example below, 2134567 is probably a GMC Reference Number but we are not certain.

{
  "resourceType": "Practitioner",
  ...
  "identifier": [
          {
            "system": "https://fhir.nhs.uk/Id/sds-user-id",
            "value": "1415870201"
          },
          {
            "system": "https://fhir.hl7.org.uk/Id/professional-code",
            "value": "2134567"
          }
        ]
  ...
}

Requirements

Often, specific identities are assigned for the agent.

Comment

SHOULD contain a professional code or SDS-user-id.

identifier:gmcCode

Definition

An identifier that applies to this person in this role.

Requirements

Often, specific identities are assigned for the agent.

identifier:gmcCode.system

Definition

Establishes the namespace for the value - that is, a URL that describes a set values that are unique.

Requirements

There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.

Comment

Identifier.system is always case sensitive.

identifier:gmpCode

Definition

Formerly called GP General National Code (GNC).

Requirements

Often, specific identities are assigned for the agent.

identifier:gmpCode.system

Definition

Establishes the namespace for the value - that is, a URL that describes a set values that are unique.

Requirements

There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.

Comment

Identifier.system is always case sensitive.

identifier:dinCode

Definition

An identifier that applies to this person in this role.

Requirements

Often, specific identities are assigned for the agent.

identifier:dinCode.system

Definition

Establishes the namespace for the value - that is, a URL that describes a set values that are unique.

Requirements

There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.

Comment

Identifier.system is always case sensitive.

identifier:gphcCode

Definition

An identifier that applies to this person in this role.

Requirements

Often, specific identities are assigned for the agent.

identifier:gphcCode.system

Definition

Establishes the namespace for the value - that is, a URL that describes a set values that are unique.

Requirements

There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.

Comment

Identifier.system is always case sensitive.

identifier:hcpcNumber

Definition

An identifier that applies to this person in this role.

Requirements

Often, specific identities are assigned for the agent.

identifier:hcpcNumber.system

Definition

Establishes the namespace for the value - that is, a URL that describes a set values that are unique.

Requirements

There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.

Comment

Identifier.system is always case sensitive.

identifier:nmcNumber

Definition

An identifier that applies to this person in this role.

Requirements

Often, specific identities are assigned for the agent.

identifier:nmcNumber.system

Definition

Establishes the namespace for the value - that is, a URL that describes a set values that are unique.

Requirements

There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.

Comment

Identifier.system is always case sensitive.

identifier:professionalNumber

Definition

A legacy system to support conversion of NPfIT/v3 CodeSysem to FHIR. This should not be used on new implementations. More accurate systems such as https://fhir.hl7.org.uk/Id/gmp-number and https://fhir.hl7.org.uk/Id/gmc-number

Although this system was intended to only be ODS/NACS Practitioner Identifiers, it has been used as a general purpose system. Therefore the codes can't be trusted e.g. 1234567 could be referring to a GPhC (pharmacist) or GMC Reference Number (doctor). These codes on their won should not be considered safe for the purposes of Practitioner identification.

Requirements

Often, specific identities are assigned for the agent.

identifier:professionalNumber.system

Definition

Establishes the namespace for the value - that is, a URL that describes a set values that are unique.

Requirements

There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.

Comment

Identifier.system is always case sensitive.

identifier:gmcReferenceNumber

Definition

This should not be confused with https://fhir.hl7.org.uk/Id/gmc-number which is the Consultants CONSULTANT_CODE.

This is considered a supplemental code and the official English NHS identifiers (https://fhir.hl7.org.uk/Id/gmc-number or https://fhir.hl7.org.uk/Id/gmp-number) should also be provided.

Requirements

Often, specific identities are assigned for the agent.

identifier:gmcReferenceNumber.system

Definition

Establishes the namespace for the value - that is, a URL that describes a set values that are unique.

Requirements

There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.

Comment

Identifier.system is always case sensitive.

identifier:sdsUserId

Definition

Used with CIS2 and Spine

Requirements

Often, specific identities are assigned for the agent.

identifier:sdsUserId.system

Definition

Establishes the namespace for the value - that is, a URL that describes a set values that are unique.

Requirements

There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.

Comment

Identifier.system is always case sensitive.

name

Definition

The name(s) associated with the practitioner.

Requirements

The name(s) that a Practitioner is known by. Where there are multiple, the name that the practitioner is usually known as should be used in the display.

Comment

The selection of the use property should ensure that there is a single usual name specified, and others use the nickname (alias), old, or other values as appropriate. In general, select the value to be used in the ResourceReference.display based on this: 1. There is more than 1 name 2. Use = usual 3. Period is current to the date of the usage 4. Use = official 5. Other order as decided by internal business rules.

telecom

Definition

A contact detail for the practitioner, e.g. a telephone number or an email address.

Requirements

Need to know how to reach a practitioner independent to any roles the practitioner may have.

Comment

Person may have multiple ways to be contacted with different uses or applicable periods. May need to have options for contacting the person urgently and to help with identification. These typically will have home numbers, or mobile numbers that are not role specific.