Command 'link' could not render: Resource was not found for 'canonical=https://fhir.hl7.org.uk/StructureDefinition/UKCore-PractitionerRole'
NHSDigitalPractitionerRole (PractitionerRole) | I | | https://fhir.hl7.org.uk/StructureDefinition/UKCore-PractitionerRole | There are no (further) constraints on this element Element idData type https://fhir.hl7.org.uk/StructureDefinition/UKCore-PractitionerRole Constraints- role-spurious: Spurious Code format must be G6NNNNNN or G7NNNNNN
identifier.where(system='https://fhir.hl7.org.uk/Id/nhsbsa-spurious-code').exists().not() or (identifier.where(system='https://fhir.hl7.org.uk/Id/nhsbsa-spurious-code').exists() and identifier.where(system='https://fhir.hl7.org.uk/Id/nhsbsa-spurious-code').value.matches('^[G]{1}[67]{1}[0-9]{6}$')) - role-sds-role-profile: SDS Role Profile Id must be 12 digits
identifier.where(system='https://fhir.nhs.uk/Id/sds-role-profile-id').exists().not() or (identifier.where(system='https://fhir.nhs.uk/Id/sds-role-profile-id').exists() and identifier.where(system='https://fhir.nhs.uk/Id/sds-role-profile-id').value.matches('^[0-9]{12}$'))
|
extension | | 0.. | | There are no (further) constraints on this element Element idPractitionerRole.extension Sliced: Unordered, Open, by url(Value) |
costCentre | S | 0..1 | Extension(Complex) | There are no (further) constraints on this element Element idPractitionerRole.extension:costCentre Data type Extension(Complex) Extension URL https://fhir.nhs.uk/StructureDefinition/Extension-NHSDigital-Account-code |
identifier | S | | | There are no (further) constraints on this element Element idPractitionerRole.identifier Definition
FHIR identifier |
OID/HL7v3 |
HL7v2 ITK |
Format |
Description |
Professional Code |
Prescribing Code |
https://fhir.hl7.org.uk/Id/nhsbsa-spurious-code |
|
|
G[67]NNNNNN |
NHS BSA Spurious Code GENERAL MEDICAL PRACTITIONER PPD CODE |
No |
Yes |
https://fhir.nhs.uk/Id/sds-role-profile-id |
1.2.826.0.1285.0.2.0.67 |
|
12 digits |
SDS Role Profile Code |
No |
No |
The SDS Role Profile Code should be sourced from NHS Identity (SmartCard), this is also held within the Spine Directory Service LDAP database.
Holds NHS BSA spurious codes which are role specific Doctor Index Number (DIN)) codes. NHS BSA spurious codes are issued when a doctor issues medication outside of their normal role, normally at another organisation. In the example below, the doctor is working in a secondary role (with SDS Role Id of 100102238986), as this a has a spurious code of 2345213. If the doctor was prescribing in their primary role this spurious code would be absent.
{
"resourceType": "PractitionerRole",
...
"identifier": [
{
"system": "https://fhir.nhs.uk/Id/sds-role-profile-id",
"value": "100102238986"
},
{
"system": "https://fhir.hl7.org.uk/Id/nhsbsa-spurious-code",
"value": "2345213"
}
],
...
}
Sliced: Unordered, Open, by system(Value) |
sdsRoleProfileID | S | ..1 | | There are no (further) constraints on this element Element idPractitionerRole.identifier:sdsRoleProfileID |
system | | | Fixed Value | There are no (further) constraints on this element Element idPractitionerRole.identifier:sdsRoleProfileID.system Fixed value https://fhir.nhs.uk/Id/sds-role-profile-id |
nhsbsaSpuriousCode | S | ..1 | | There are no (further) constraints on this element Element idPractitionerRole.identifier:nhsbsaSpuriousCode |
system | | | Fixed Value | There are no (further) constraints on this element Element idPractitionerRole.identifier:nhsbsaSpuriousCode.system Fixed value https://fhir.hl7.org.uk/Id/nhsbsa-spurious-code |
practitioner | S I | | Reference(NHSDigitalPractitioner) | There are no (further) constraints on this element Element idPractitionerRole.practitioner Definition This MUST either be a reference to a Practitioner resource or an identifier reference plus a display. In both cases the referenced resource or identfier reference should contain a professional code.
It is recommended an identifier reference and display (practioner full name) is included. This identifier should be the Practitioner's primary professional code (see NHSDigital-Practitioner for details on professional codes).
"practitioner": {
"display": "Dr Smith",
"identifier": {
"system": "https://fhir.hl7.org.uk/Id/gmc-number",
"value": "C9876543"
}
},
For EPS, currently a Resource reference is required.
"practitioner": {
"reference": "urn:uuid:1557E58E-3B1E-41DD-B3B5-D4D393DC5A3D",
"display": "Dr Smith"
},
Data type Reference(NHSDigitalPractitioner) Constraints- nhsd-2: An identifier reference or resource reference must be provided
(reference.exists() or identifier.exists()) - role-nmc: NMC must be of the format NNANNNNA
identifier.exists().not() or identifier.where(system='https://fhir.hl7.org.uk/Id/nmc-number').exists().not() or (identifier.where(system='https://fhir.hl7.org.uk/Id/nmc-number').exists() and identifier.where(system='https://fhir.hl7.org.uk/Id/nmc-number').value.matches('^[0-9]{2}[A-Z]{1}[0-9]{4}[A-Z]{1}$')) - role-gmp: GMP must be of the format GNNNNNNN and not be a spurious code (starts with G6 or G7)
identifier.exists().not() or identifier.where(system='https://fhir.hl7.org.uk/Id/gmp-number').exists().not() or (identifier.where(system='https://fhir.hl7.org.uk/Id/gmp-number').exists() and identifier.where(system='https://fhir.hl7.org.uk/Id/gmp-number').value.matches('^[G]{1}[01234589]{1}[0-9]{6}$')) - role-gmc: GMC must be of the format CNNNNNNN
identifier.exists().not() or identifier.where(system='https://fhir.hl7.org.uk/Id/gmc-number').exists().not() or (identifier.where(system='https://fhir.hl7.org.uk/Id/gmc-number').exists() and identifier.where(system='https://fhir.hl7.org.uk/Id/gmc-number').value.matches('^[C]{1}[0-9]{7}$')) - role-gphc: GPHC must be of the format NNNNNNN
identifier.exists().not() or identifier.where(system='https://fhir.hl7.org.uk/Id/gphc-number').exists().not() or (identifier.where(system='https://fhir.hl7.org.uk/Id/gphc-number').exists() and identifier.where(system='https://fhir.hl7.org.uk/Id/gphc-number').value.matches('^[0-9]{7}$')) - role-hcpc: HCPC must be of the format AANNNNNN
identifier.exists().not() or identifier.where(system='https://fhir.hl7.org.uk/Id/hcpc-number').exists().not() or (identifier.where(system='https://fhir.hl7.org.uk/Id/hcpc-number').exists() and identifier.where(system='https://fhir.hl7.org.uk/Id/hcpc-number').value.matches('^[A-Z]{2}[0-9]{6}$')) - role-din: DIN format must be NNNNNN
identifier.exists().not() or identifier.where(system='https://fhir.hl7.org.uk/Id/din-number').exists().not() or (identifier.where(system='https://fhir.hl7.org.uk/Id/din-number').exists() and identifier.where(system='https://fhir.hl7.org.uk/Id/din-number').value.matches('^[0-9]{6}$')) - role-sds-user-numeric: sds-user-id must be numeric
identifier.where(system='https://fhir.nhs.uk/Id/sds-user-id').exists().not() or (identifier.where(system='https://fhir.nhs.uk/Id/sds-user-id').exists() and identifier.where(system='https://fhir.nhs.uk/Id/sds-user-id').value.matches('^[0-9]+$')) - role-gmcreferencenumber: GMC Reference Number must be of the format NNNNNNN
identifier.where(system='https://fhir.hl7.org.uk/Id/gmc-reference-number').exists().not() or (identifier.where(system='https://fhir.hl7.org.uk/Id/gphc-number').exists() and identifier.where(system='https://fhir.hl7.org.uk/Id/gmc-reference-number').value.matches('^[0-9]{7}$')) - nacs-code-retired: 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.where(system='https://fhir.hl7.org.uk/Id/professional-code').exists().not()
|
organization | S I | | Reference(NHSDigitalOrganization) | There are no (further) constraints on this element Element idPractitionerRole.organization Definition This MUST either be a reference to a Organization resource or an identifier reference. In both cases the reference must contain an ANANA/ODS organisation code.
organisation resource references
It is recommended an identifier reference is included.
"organization": {
"identifier": {
"system": "https://fhir.nhs.uk/Id/ods-organization-code",
"value": "RBA"
},
"display": "TAUNTON AND SOMERSET NHS FOUNDATION TRUST"
}
Optionally Resource reference can be provided. This is required in the current version of EPS but this will be changed to supporting the identifier reference only.
"organization": {
"reference": "urn:uuid:17c4270d-6966-4788-8cbc-1d1d63536b25",
"identifier": {
"system": "https://fhir.nhs.uk/Id/ods-organization-code",
"value": "RBA"
},
"display": "TAUNTON AND SOMERSET NHS FOUNDATION TRUST"
}
Data type Reference(NHSDigitalOrganization) Constraints- nhsd-1: PractitionerRole.organization - An identifier reference or resource reference should be provided
(reference.exists() or identifier.exists())
|
identifier | | | | There are no (further) constraints on this element |
system | | 1.. | | There are no (further) constraints on this element Element idPractitionerRole.organization.identifier.system |
value | | 1.. | | There are no (further) constraints on this element Element idPractitionerRole.organization.identifier.value |
code | S | | Binding | There are no (further) constraints on this element Element idDefinition Only supply if this is known from SmartCard/CIS2 data.
"code": [
{
"coding": [
{
"system": "https://fhir.nhs.uk/CodeSystem/NHSDigital-SDS-JobRoleCode",
"code": "S0030:G0100:R0620"
}
]
}
],
The previous system for this entry was https://fhir.hl7org.uk/CodeSystem/UKCore-SDSJobRoleName , this has been retired and https://fhir.nhs.uk/CodeSystem/NHSDigital-SDS-JobRoleCode should be used instead.
Binding NHSDigitalPractitionerRoleCode (extensible) |
coding | | 1.. | | There are no (further) constraints on this element Element idPractitionerRole.code.coding Sliced: Unordered, Open, by system(Value) |
(All Slices) | | | | There are no (further) constraints on this element |
system | | 1.. | | There are no (further) constraints on this element Element idPractitionerRole.code.coding.system |
code | | 1.. | | There are no (further) constraints on this element Element idPractitionerRole.code.coding.code |
sdsJobRoleCode | S | ..1 | | There are no (further) constraints on this element Element idPractitionerRole.code.coding:sdsJobRoleCode Short description SDS Job Role Code Definition This value should be sourced from either APIM OAuth2 userinfo endpoint, SDS LDAP or CIS2/SmartCard details.
The CodeSystem is variable and is not present in this Implementation Guide.
|
system | | | Fixed Value | There are no (further) constraints on this element Element idPractitionerRole.code.coding:sdsJobRoleCode.system Fixed value https://fhir.nhs.uk/CodeSystem/NHSDigital-SDS-JobRoleCode |
specialty | S | | | There are no (further) constraints on this element Element idPractitionerRole.specialty Definition This is should be the specialty linked to the role and is not necessarily the practitioners main specialty.
This can be supplemented by SNOMED CT codes from {{link:http://hl7.org/fhir/ValueSet/c80-practice-codes}}, no ConceptMap currently exists for mapping between the two.
"specialty": [
{
"coding": [
{
"system": "https://fhir.nhs.uk/CodeSystem/NHSDataModelAndDictionary-clinical-specialty",
"code": "100",
"display": "GENERAL SURGERY"
}
]
}
],
|
coding | | 1.. | | There are no (further) constraints on this element Element idPractitionerRole.specialty.coding Sliced: Unordered, Open, by system(Value) |
(All Slices) | | | | There are no (further) constraints on this element |
system | | 1.. | | There are no (further) constraints on this element Element idPractitionerRole.specialty.coding.system |
code | | 1.. | | There are no (further) constraints on this element Element idPractitionerRole.specialty.coding.code |
display | | 1.. | | There are no (further) constraints on this element Element idPractitionerRole.specialty.coding.display |
NHSDataDictionarySpecialty | S | | Binding | There are no (further) constraints on this element Element idPractitionerRole.specialty.coding:NHSDataDictionarySpecialty Binding NHS Data Dictionary Specialty
NHSDataDictionaryMainClinicalSpecialty (required) |
system | | | Fixed Value | There are no (further) constraints on this element Element idPractitionerRole.specialty.coding:NHSDataDictionarySpecialty.system Fixed value https://fhir.nhs.uk/CodeSystem/NHSDataModelAndDictionary-clinical-specialty |
SNOMEDSpecialty | S | | Binding | There are no (further) constraints on this element Element idPractitionerRole.specialty.coding:SNOMEDSpecialty Binding Specific specialty associated with the agency.
PracticeSettingCodeValueSet (preferred) |
system | | | Fixed Value | There are no (further) constraints on this element Element idPractitionerRole.specialty.coding:SNOMEDSpecialty.system Fixed value |
location | I | | Reference(NHSDigitalLocation) | There are no (further) constraints on this element Element idPractitionerRole.location Definition The contact address for the practitioner for the service they are providing in this role. This will often be the surgery address, clinic or service address.
If using ODS Codes, the address on ODS must be checked to ensure it is correct. If the address is not correct, then Resource reference MUST be supplied.
"location": [
{
"identifier": {
"system": "https://fhir.nhs.uk/Id/ods-organization-code",
"value": "RCB55"
}
"display": "YORK HOSPITAL"
}
]
For EPS, currently a Resource reference is required.
"location": [
{
"reference": "urn:uuid:ecc2db8e-3757-4758-a4f1-7f4c7e06662f",
"display": "YORK HOSPITAL"
}
]
Data type Reference(NHSDigitalLocation) Constraints- nhsd-3: PractitionerRole.location - An identifier or resource reference must be provided
(reference.exists() or identifier.exists())
|
identifier | | | | There are no (further) constraints on this element |
system | | 1.. | | There are no (further) constraints on this element Element idPractitionerRole.location.identifier.system |
value | | 1.. | | There are no (further) constraints on this element Element idPractitionerRole.location.identifier.value |
healthcareService | S I | ..1 | Reference(NHSDigitalHealthcareService) | There are no (further) constraints on this element Element idPractitionerRole.healthcareService Definition SHOULD be provided for a practitioner in secondary care and will be a reference to clinic or service. This referenced resource or the identifier reference SHOULD contain a ODS/ANANA identifier. In secondary care Electronic Prescription Service (EPS) this will also be called prescribing cost centre. This is used for reimbursements from NHS BSA. In secondary care the healthchare/service cost centre may also be the ODS code for the clinic.
healthcareService Resource reference
An identifier reference MUST be included. For secondary care organisations this will be the ODS/ANANA Cost Centre code given to a clinic.
"healthcareService":
[
{
"identifier": {
"system": "https://fhir.nhs.uk/Id/ods-organization-code",
"value": "A99968"
}
"display": "SOMERSET BOWEL CANCER SCREENING CENTRE"
}
]
Optionally Resource reference can be provided. This is required in the current version of EPS but this will be changed to supporting the identifier reference only.
"healthcareService":
[
{
"reference": "urn:uuid:54b0506d-49af-4245-9d40-d7d64902055e",
"identifier": {
"system": "https://fhir.nhs.uk/Id/ods-organization-code",
"value": "A99968"
}
"display": "SOMERSET BOWEL CANCER SCREENING CENTRE"
}
]
Data type Reference(NHSDigitalHealthcareService) Constraints- nhsd-4: PractitionerRole.healthcareService - An identifier reference or resource reference must be provided
(reference.exists() or (identifier.exists()))
|
identifier | | | | There are no (further) constraints on this element |
system | | 1.. | | There are no (further) constraints on this element Element idPractitionerRole.healthcareService.identifier.system |
value | | 1.. | | There are no (further) constraints on this element Element idPractitionerRole.healthcareService.identifier.value |
telecom | S | | | There are no (further) constraints on this element Element idDefinition At least one telecom number MUST be provided.
Contact details that are specific to the role/location/service. Often practitioners have a dedicated line for each location (or service) that they work at and need to be able to define separate contact details for each of these.
This is not the personnel contact number of the Practitioner, it the contact number for the practitioner in this role and may be the phone number of the clinic, main or branch surgery.
"telecom": [
{
"system": "phone",
"value": "01234567890",
"use": "work"
}
]
|
value | | 1.. | | There are no (further) constraints on this element Element idPractitionerRole.telecom.value |
use | | 1.. | | There are no (further) constraints on this element Element idPractitionerRole.telecom.use |
from
Command 'link' could not render: Resource was not found for 'canonical=https://fhir.hl7.org.uk/StructureDefinition/UKCore-PractitionerRole'
NHSDigitalPractitionerRole (PractitionerRole) | I | | https://fhir.hl7.org.uk/StructureDefinition/UKCore-PractitionerRole | There are no (further) constraints on this element Element idData type https://fhir.hl7.org.uk/StructureDefinition/UKCore-PractitionerRole Constraints- role-spurious: Spurious Code format must be G6NNNNNN or G7NNNNNN
identifier.where(system='https://fhir.hl7.org.uk/Id/nhsbsa-spurious-code').exists().not() or (identifier.where(system='https://fhir.hl7.org.uk/Id/nhsbsa-spurious-code').exists() and identifier.where(system='https://fhir.hl7.org.uk/Id/nhsbsa-spurious-code').value.matches('^[G]{1}[67]{1}[0-9]{6}$')) - role-sds-role-profile: SDS Role Profile Id must be 12 digits
identifier.where(system='https://fhir.nhs.uk/Id/sds-role-profile-id').exists().not() or (identifier.where(system='https://fhir.nhs.uk/Id/sds-role-profile-id').exists() and identifier.where(system='https://fhir.nhs.uk/Id/sds-role-profile-id').value.matches('^[0-9]{12}$'))
|
extension | | 0.. | | There are no (further) constraints on this element Element idPractitionerRole.extension Sliced: Unordered, Open, by url(Value) |
costCentre | S | 0..1 | Extension(Complex) | There are no (further) constraints on this element Element idPractitionerRole.extension:costCentre Data type Extension(Complex) Extension URL https://fhir.nhs.uk/StructureDefinition/Extension-NHSDigital-Account-code |
identifier | S | | | There are no (further) constraints on this element Element idPractitionerRole.identifier Definition
FHIR identifier |
OID/HL7v3 |
HL7v2 ITK |
Format |
Description |
Professional Code |
Prescribing Code |
https://fhir.hl7.org.uk/Id/nhsbsa-spurious-code |
|
|
G[67]NNNNNN |
NHS BSA Spurious Code GENERAL MEDICAL PRACTITIONER PPD CODE |
No |
Yes |
https://fhir.nhs.uk/Id/sds-role-profile-id |
1.2.826.0.1285.0.2.0.67 |
|
12 digits |
SDS Role Profile Code |
No |
No |
The SDS Role Profile Code should be sourced from NHS Identity (SmartCard), this is also held within the Spine Directory Service LDAP database.
Holds NHS BSA spurious codes which are role specific Doctor Index Number (DIN)) codes. NHS BSA spurious codes are issued when a doctor issues medication outside of their normal role, normally at another organisation. In the example below, the doctor is working in a secondary role (with SDS Role Id of 100102238986), as this a has a spurious code of 2345213. If the doctor was prescribing in their primary role this spurious code would be absent.
{
"resourceType": "PractitionerRole",
...
"identifier": [
{
"system": "https://fhir.nhs.uk/Id/sds-role-profile-id",
"value": "100102238986"
},
{
"system": "https://fhir.hl7.org.uk/Id/nhsbsa-spurious-code",
"value": "2345213"
}
],
...
}
Sliced: Unordered, Open, by system(Value) |
sdsRoleProfileID | S | ..1 | | There are no (further) constraints on this element Element idPractitionerRole.identifier:sdsRoleProfileID |
system | | | Fixed Value | There are no (further) constraints on this element Element idPractitionerRole.identifier:sdsRoleProfileID.system Fixed value https://fhir.nhs.uk/Id/sds-role-profile-id |
nhsbsaSpuriousCode | S | ..1 | | There are no (further) constraints on this element Element idPractitionerRole.identifier:nhsbsaSpuriousCode |
system | | | Fixed Value | There are no (further) constraints on this element Element idPractitionerRole.identifier:nhsbsaSpuriousCode.system Fixed value https://fhir.hl7.org.uk/Id/nhsbsa-spurious-code |
practitioner | S I | | Reference(NHSDigitalPractitioner) | There are no (further) constraints on this element Element idPractitionerRole.practitioner Definition This MUST either be a reference to a Practitioner resource or an identifier reference plus a display. In both cases the referenced resource or identfier reference should contain a professional code.
It is recommended an identifier reference and display (practioner full name) is included. This identifier should be the Practitioner's primary professional code (see NHSDigital-Practitioner for details on professional codes).
"practitioner": {
"display": "Dr Smith",
"identifier": {
"system": "https://fhir.hl7.org.uk/Id/gmc-number",
"value": "C9876543"
}
},
For EPS, currently a Resource reference is required.
"practitioner": {
"reference": "urn:uuid:1557E58E-3B1E-41DD-B3B5-D4D393DC5A3D",
"display": "Dr Smith"
},
Data type Reference(NHSDigitalPractitioner) Constraints- nhsd-2: An identifier reference or resource reference must be provided
(reference.exists() or identifier.exists()) - role-nmc: NMC must be of the format NNANNNNA
identifier.exists().not() or identifier.where(system='https://fhir.hl7.org.uk/Id/nmc-number').exists().not() or (identifier.where(system='https://fhir.hl7.org.uk/Id/nmc-number').exists() and identifier.where(system='https://fhir.hl7.org.uk/Id/nmc-number').value.matches('^[0-9]{2}[A-Z]{1}[0-9]{4}[A-Z]{1}$')) - role-gmp: GMP must be of the format GNNNNNNN and not be a spurious code (starts with G6 or G7)
identifier.exists().not() or identifier.where(system='https://fhir.hl7.org.uk/Id/gmp-number').exists().not() or (identifier.where(system='https://fhir.hl7.org.uk/Id/gmp-number').exists() and identifier.where(system='https://fhir.hl7.org.uk/Id/gmp-number').value.matches('^[G]{1}[01234589]{1}[0-9]{6}$')) - role-gmc: GMC must be of the format CNNNNNNN
identifier.exists().not() or identifier.where(system='https://fhir.hl7.org.uk/Id/gmc-number').exists().not() or (identifier.where(system='https://fhir.hl7.org.uk/Id/gmc-number').exists() and identifier.where(system='https://fhir.hl7.org.uk/Id/gmc-number').value.matches('^[C]{1}[0-9]{7}$')) - role-gphc: GPHC must be of the format NNNNNNN
identifier.exists().not() or identifier.where(system='https://fhir.hl7.org.uk/Id/gphc-number').exists().not() or (identifier.where(system='https://fhir.hl7.org.uk/Id/gphc-number').exists() and identifier.where(system='https://fhir.hl7.org.uk/Id/gphc-number').value.matches('^[0-9]{7}$')) - role-hcpc: HCPC must be of the format AANNNNNN
identifier.exists().not() or identifier.where(system='https://fhir.hl7.org.uk/Id/hcpc-number').exists().not() or (identifier.where(system='https://fhir.hl7.org.uk/Id/hcpc-number').exists() and identifier.where(system='https://fhir.hl7.org.uk/Id/hcpc-number').value.matches('^[A-Z]{2}[0-9]{6}$')) - role-din: DIN format must be NNNNNN
identifier.exists().not() or identifier.where(system='https://fhir.hl7.org.uk/Id/din-number').exists().not() or (identifier.where(system='https://fhir.hl7.org.uk/Id/din-number').exists() and identifier.where(system='https://fhir.hl7.org.uk/Id/din-number').value.matches('^[0-9]{6}$')) - role-sds-user-numeric: sds-user-id must be numeric
identifier.where(system='https://fhir.nhs.uk/Id/sds-user-id').exists().not() or (identifier.where(system='https://fhir.nhs.uk/Id/sds-user-id').exists() and identifier.where(system='https://fhir.nhs.uk/Id/sds-user-id').value.matches('^[0-9]+$')) - role-gmcreferencenumber: GMC Reference Number must be of the format NNNNNNN
identifier.where(system='https://fhir.hl7.org.uk/Id/gmc-reference-number').exists().not() or (identifier.where(system='https://fhir.hl7.org.uk/Id/gphc-number').exists() and identifier.where(system='https://fhir.hl7.org.uk/Id/gmc-reference-number').value.matches('^[0-9]{7}$')) - nacs-code-retired: 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.where(system='https://fhir.hl7.org.uk/Id/professional-code').exists().not()
|
organization | S I | | Reference(NHSDigitalOrganization) | There are no (further) constraints on this element Element idPractitionerRole.organization Definition This MUST either be a reference to a Organization resource or an identifier reference. In both cases the reference must contain an ANANA/ODS organisation code.
organisation resource references
It is recommended an identifier reference is included.
"organization": {
"identifier": {
"system": "https://fhir.nhs.uk/Id/ods-organization-code",
"value": "RBA"
},
"display": "TAUNTON AND SOMERSET NHS FOUNDATION TRUST"
}
Optionally Resource reference can be provided. This is required in the current version of EPS but this will be changed to supporting the identifier reference only.
"organization": {
"reference": "urn:uuid:17c4270d-6966-4788-8cbc-1d1d63536b25",
"identifier": {
"system": "https://fhir.nhs.uk/Id/ods-organization-code",
"value": "RBA"
},
"display": "TAUNTON AND SOMERSET NHS FOUNDATION TRUST"
}
Data type Reference(NHSDigitalOrganization) Constraints- nhsd-1: PractitionerRole.organization - An identifier reference or resource reference should be provided
(reference.exists() or identifier.exists())
|
identifier | | | | There are no (further) constraints on this element |
system | | 1.. | | There are no (further) constraints on this element Element idPractitionerRole.organization.identifier.system |
value | | 1.. | | There are no (further) constraints on this element Element idPractitionerRole.organization.identifier.value |
code | S | | Binding | There are no (further) constraints on this element Element idDefinition Only supply if this is known from SmartCard/CIS2 data.
"code": [
{
"coding": [
{
"system": "https://fhir.nhs.uk/CodeSystem/NHSDigital-SDS-JobRoleCode",
"code": "S0030:G0100:R0620"
}
]
}
],
The previous system for this entry was https://fhir.hl7org.uk/CodeSystem/UKCore-SDSJobRoleName , this has been retired and https://fhir.nhs.uk/CodeSystem/NHSDigital-SDS-JobRoleCode should be used instead.
Binding NHSDigitalPractitionerRoleCode (extensible) |
coding | | 1.. | | There are no (further) constraints on this element Element idPractitionerRole.code.coding Sliced: Unordered, Open, by system(Value) |
(All Slices) | | | | There are no (further) constraints on this element |
system | | 1.. | | There are no (further) constraints on this element Element idPractitionerRole.code.coding.system |
code | | 1.. | | There are no (further) constraints on this element Element idPractitionerRole.code.coding.code |
sdsJobRoleCode | S | ..1 | | There are no (further) constraints on this element Element idPractitionerRole.code.coding:sdsJobRoleCode Short description SDS Job Role Code Definition This value should be sourced from either APIM OAuth2 userinfo endpoint, SDS LDAP or CIS2/SmartCard details.
The CodeSystem is variable and is not present in this Implementation Guide.
|
system | | | Fixed Value | There are no (further) constraints on this element Element idPractitionerRole.code.coding:sdsJobRoleCode.system Fixed value https://fhir.nhs.uk/CodeSystem/NHSDigital-SDS-JobRoleCode |
specialty | S | | | There are no (further) constraints on this element Element idPractitionerRole.specialty Definition This is should be the specialty linked to the role and is not necessarily the practitioners main specialty.
This can be supplemented by SNOMED CT codes from {{link:http://hl7.org/fhir/ValueSet/c80-practice-codes}}, no ConceptMap currently exists for mapping between the two.
"specialty": [
{
"coding": [
{
"system": "https://fhir.nhs.uk/CodeSystem/NHSDataModelAndDictionary-clinical-specialty",
"code": "100",
"display": "GENERAL SURGERY"
}
]
}
],
|
coding | | 1.. | | There are no (further) constraints on this element Element idPractitionerRole.specialty.coding Sliced: Unordered, Open, by system(Value) |
(All Slices) | | | | There are no (further) constraints on this element |
system | | 1.. | | There are no (further) constraints on this element Element idPractitionerRole.specialty.coding.system |
code | | 1.. | | There are no (further) constraints on this element Element idPractitionerRole.specialty.coding.code |
display | | 1.. | | There are no (further) constraints on this element Element idPractitionerRole.specialty.coding.display |
NHSDataDictionarySpecialty | S | | Binding | There are no (further) constraints on this element Element idPractitionerRole.specialty.coding:NHSDataDictionarySpecialty Binding NHS Data Dictionary Specialty
NHSDataDictionaryMainClinicalSpecialty (required) |
system | | | Fixed Value | There are no (further) constraints on this element Element idPractitionerRole.specialty.coding:NHSDataDictionarySpecialty.system Fixed value https://fhir.nhs.uk/CodeSystem/NHSDataModelAndDictionary-clinical-specialty |
SNOMEDSpecialty | S | | Binding | There are no (further) constraints on this element Element idPractitionerRole.specialty.coding:SNOMEDSpecialty Binding Specific specialty associated with the agency.
PracticeSettingCodeValueSet (preferred) |
system | | | Fixed Value | There are no (further) constraints on this element Element idPractitionerRole.specialty.coding:SNOMEDSpecialty.system Fixed value |
location | I | | Reference(NHSDigitalLocation) | There are no (further) constraints on this element Element idPractitionerRole.location Definition The contact address for the practitioner for the service they are providing in this role. This will often be the surgery address, clinic or service address.
If using ODS Codes, the address on ODS must be checked to ensure it is correct. If the address is not correct, then Resource reference MUST be supplied.
"location": [
{
"identifier": {
"system": "https://fhir.nhs.uk/Id/ods-organization-code",
"value": "RCB55"
}
"display": "YORK HOSPITAL"
}
]
For EPS, currently a Resource reference is required.
"location": [
{
"reference": "urn:uuid:ecc2db8e-3757-4758-a4f1-7f4c7e06662f",
"display": "YORK HOSPITAL"
}
]
Data type Reference(NHSDigitalLocation) Constraints- nhsd-3: PractitionerRole.location - An identifier or resource reference must be provided
(reference.exists() or identifier.exists())
|
identifier | | | | There are no (further) constraints on this element |
system | | 1.. | | There are no (further) constraints on this element Element idPractitionerRole.location.identifier.system |
value | | 1.. | | There are no (further) constraints on this element Element idPractitionerRole.location.identifier.value |
healthcareService | S I | ..1 | Reference(NHSDigitalHealthcareService) | There are no (further) constraints on this element Element idPractitionerRole.healthcareService Definition SHOULD be provided for a practitioner in secondary care and will be a reference to clinic or service. This referenced resource or the identifier reference SHOULD contain a ODS/ANANA identifier. In secondary care Electronic Prescription Service (EPS) this will also be called prescribing cost centre. This is used for reimbursements from NHS BSA. In secondary care the healthchare/service cost centre may also be the ODS code for the clinic.
healthcareService Resource reference
An identifier reference MUST be included. For secondary care organisations this will be the ODS/ANANA Cost Centre code given to a clinic.
"healthcareService":
[
{
"identifier": {
"system": "https://fhir.nhs.uk/Id/ods-organization-code",
"value": "A99968"
}
"display": "SOMERSET BOWEL CANCER SCREENING CENTRE"
}
]
Optionally Resource reference can be provided. This is required in the current version of EPS but this will be changed to supporting the identifier reference only.
"healthcareService":
[
{
"reference": "urn:uuid:54b0506d-49af-4245-9d40-d7d64902055e",
"identifier": {
"system": "https://fhir.nhs.uk/Id/ods-organization-code",
"value": "A99968"
}
"display": "SOMERSET BOWEL CANCER SCREENING CENTRE"
}
]
Data type Reference(NHSDigitalHealthcareService) Constraints- nhsd-4: PractitionerRole.healthcareService - An identifier reference or resource reference must be provided
(reference.exists() or (identifier.exists()))
|
identifier | | | | There are no (further) constraints on this element |
system | | 1.. | | There are no (further) constraints on this element Element idPractitionerRole.healthcareService.identifier.system |
value | | 1.. | | There are no (further) constraints on this element Element idPractitionerRole.healthcareService.identifier.value |
telecom | S | | | There are no (further) constraints on this element Element idDefinition At least one telecom number MUST be provided.
Contact details that are specific to the role/location/service. Often practitioners have a dedicated line for each location (or service) that they work at and need to be able to define separate contact details for each of these.
This is not the personnel contact number of the Practitioner, it the contact number for the practitioner in this role and may be the phone number of the clinic, main or branch surgery.
"telecom": [
{
"system": "phone",
"value": "01234567890",
"use": "work"
}
]
|
value | | 1.. | | There are no (further) constraints on this element Element idPractitionerRole.telecom.value |
use | | 1.. | | There are no (further) constraints on this element Element idPractitionerRole.telecom.use |
You dot not have a license to run FQL queries.
Constraint Profiles
You dot not have a license to run FQL queries.
Definition
A specific set of Roles/Locations/specialties/services that a practitioner may perform at an organization for a period of time.
Constraints
extension:costCentre
Definition
Optional Extension Element - found in all resources.
identifier
Definition
The SDS Role Profile Code should be sourced from NHS Identity (SmartCard), this is also held within the Spine Directory Service LDAP database.
Holds NHS BSA spurious codes which are role specific Doctor Index Number (DIN)) codes. NHS BSA spurious codes are issued when a doctor issues medication outside of their normal role, normally at another organisation. In the example below, the doctor is working in a secondary role (with SDS Role Id of 100102238986), as this a has a spurious code of 2345213. If the doctor was prescribing in their primary role this spurious code would be absent.
{
"resourceType": "PractitionerRole",
...
"identifier": [
{
"system": "https://fhir.nhs.uk/Id/sds-role-profile-id",
"value": "100102238986"
},
{
"system": "https://fhir.hl7.org.uk/Id/nhsbsa-spurious-code",
"value": "2345213"
}
],
...
}
Requirements
Often, specific identities are assigned for the agent.
identifier:sdsRoleProfileID
Definition
An identifier that applies to this person in this role.
Requirements
Often, specific identities are assigned for the agent.
identifier:sdsRoleProfileID.system
|
|
Element Id |
PractitionerRole.identifier:sdsRoleProfileID.system |
Cardinality |
1..1 |
Fixed Value |
https://fhir.nhs.uk/Id/sds-role-profile-id |
type |
uri |
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.
Identifier.system is always case sensitive.
identifier:nhsbsaSpuriousCode
Definition
An identifier that applies to this person in this role.
Requirements
Often, specific identities are assigned for the agent.
identifier:nhsbsaSpuriousCode.system
|
|
Element Id |
PractitionerRole.identifier:nhsbsaSpuriousCode.system |
Cardinality |
1..1 |
Fixed Value |
https://fhir.hl7.org.uk/Id/nhsbsa-spurious-code |
type |
uri |
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.
Identifier.system is always case sensitive.
practitioner
Definition
This MUST either be a reference to a Practitioner resource or an identifier reference plus a display. In both cases the referenced resource or identfier reference should contain a professional code.
It is recommended an identifier reference and display (practioner full name) is included. This identifier should be the Practitioner's primary professional code (see NHSDigital-Practitioner
for details on professional codes).
"practitioner": {
"display": "Dr Smith",
"identifier": {
"system": "https://fhir.hl7.org.uk/Id/gmc-number",
"value": "C9876543"
}
},
For EPS, currently a Resource reference is required.
"practitioner": {
"reference": "urn:uuid:1557E58E-3B1E-41DD-B3B5-D4D393DC5A3D",
"display": "Dr Smith"
},
Constraints
- nhsd-2 (WARNING) An identifier reference or resource reference must be provided
- role-nmc (WARNING) NMC must be of the format NNANNNNA
- role-gmp (ERROR) GMP must be of the format GNNNNNNN and not be a spurious code (starts with G6 or G7)
- role-gmc (ERROR) GMC must be of the format CNNNNNNN
- role-gphc (WARNING) GPHC must be of the format NNNNNNN
- role-hcpc (WARNING) HCPC must be of the format AANNNNNN
- role-din (WARNING) DIN format must be NNNNNN
- role-sds-user-numeric (ERROR) sds-user-id must be numeric
- role-gmcreferencenumber (ERROR) GMC Reference Number must be of the format NNNNNNN
- 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).
organization
Definition
This MUST either be a reference to a Organization resource or an identifier reference. In both cases the reference must contain an ANANA/ODS organisation code.
organisation resource references
It is recommended an identifier reference is included.
"organization": {
"identifier": {
"system": "https://fhir.nhs.uk/Id/ods-organization-code",
"value": "RBA"
},
"display": "TAUNTON AND SOMERSET NHS FOUNDATION TRUST"
}
Optionally Resource reference can be provided. This is required in the current version of EPS but this will be changed to supporting the identifier reference only.
"organization": {
"reference": "urn:uuid:17c4270d-6966-4788-8cbc-1d1d63536b25",
"identifier": {
"system": "https://fhir.nhs.uk/Id/ods-organization-code",
"value": "RBA"
},
"display": "TAUNTON AND SOMERSET NHS FOUNDATION TRUST"
}
Constraints
- nhsd-1 (WARNING) PractitionerRole.organization - An identifier reference or resource reference should be provided
code
Definition
Only supply if this is known from SmartCard/CIS2 data.
"code": [
{
"coding": [
{
"system": "https://fhir.nhs.uk/CodeSystem/NHSDigital-SDS-JobRoleCode",
"code": "S0030:G0100:R0620"
}
]
}
],
The previous system for this entry was https://fhir.hl7org.uk/CodeSystem/UKCore-SDSJobRoleName
, this has been retired and https://fhir.nhs.uk/CodeSystem/NHSDigital-SDS-JobRoleCode
should be used instead.
Requirements
Need to know what authority the practitioner has - what can they do?
A person may have more than one role.
code.coding:sdsJobRoleCode
Definition
This value should be sourced from either APIM OAuth2 userinfo endpoint, SDS LDAP or CIS2/SmartCard details.
The CodeSystem is variable and is not present in this Implementation Guide.
Requirements
Allows for alternative encodings within a code system, and translations to other code systems.
Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.
code.coding:sdsJobRoleCode.system
|
|
Element Id |
PractitionerRole.code.coding:sdsJobRoleCode.system |
Cardinality |
0..1 |
Fixed Value |
https://fhir.nhs.uk/CodeSystem/NHSDigital-SDS-JobRoleCode |
type |
uri |
Definition
The identification of the code system that defines the meaning of the symbol in the code.
Requirements
Need to be unambiguous about the source of the definition of the symbol.
The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously.
specialty
Definition
This is should be the specialty linked to the role and is not necessarily the practitioners main specialty.
This can be supplemented by SNOMED CT codes from PracticeSettingCodeValueSet, no ConceptMap currently exists for mapping between the two.
"specialty": [
{
"coding": [
{
"system": "https://fhir.nhs.uk/CodeSystem/NHSDataModelAndDictionary-clinical-specialty",
"code": "100",
"display": "GENERAL SURGERY"
}
]
}
],
specialty.coding:NHSDataDictionarySpecialty
Definition
A reference to a code defined by a terminology system.
Requirements
Allows for alternative encodings within a code system, and translations to other code systems.
Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.
specialty.coding:NHSDataDictionarySpecialty.system
|
|
Element Id |
PractitionerRole.specialty.coding:NHSDataDictionarySpecialty.system |
Cardinality |
0..1 |
Fixed Value |
https://fhir.nhs.uk/CodeSystem/NHSDataModelAndDictionary-clinical-specialty |
type |
uri |
Definition
The identification of the code system that defines the meaning of the symbol in the code.
Requirements
Need to be unambiguous about the source of the definition of the symbol.
The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously.
specialty.coding:SNOMEDSpecialty
Definition
A reference to a code defined by a terminology system.
Requirements
Allows for alternative encodings within a code system, and translations to other code systems.
Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.
specialty.coding:SNOMEDSpecialty.system
|
|
Element Id |
PractitionerRole.specialty.coding:SNOMEDSpecialty.system |
Cardinality |
0..1 |
Fixed Value |
http://snomed.info/sct |
type |
uri |
Definition
The identification of the code system that defines the meaning of the symbol in the code.
Requirements
Need to be unambiguous about the source of the definition of the symbol.
The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously.
location
Definition
The contact address for the practitioner for the service they are providing in this role. This will often be the surgery address, clinic or service address.
If using ODS Codes, the address on ODS must be checked to ensure it is correct. If the address is not correct, then Resource reference MUST be supplied.
"location": [
{
"identifier": {
"system": "https://fhir.nhs.uk/Id/ods-organization-code",
"value": "RCB55"
}
"display": "YORK HOSPITAL"
}
]
For EPS, currently a Resource reference is required.
"location": [
{
"reference": "urn:uuid:ecc2db8e-3757-4758-a4f1-7f4c7e06662f",
"display": "YORK HOSPITAL"
}
]
Constraints
- nhsd-3 (ERROR) PractitionerRole.location - An identifier or resource reference must be provided
healthcareService
Definition
SHOULD be provided for a practitioner in secondary care and will be a reference to clinic or service. This referenced resource or the identifier reference SHOULD contain a ODS/ANANA identifier. In secondary care Electronic Prescription Service (EPS) this will also be called prescribing cost centre. This is used for reimbursements from NHS BSA. In secondary care the healthchare/service cost centre may also be the ODS code for the clinic.
healthcareService Resource reference
An identifier reference MUST be included. For secondary care organisations this will be the ODS/ANANA Cost Centre code given to a clinic.
"healthcareService":
[
{
"identifier": {
"system": "https://fhir.nhs.uk/Id/ods-organization-code",
"value": "A99968"
}
"display": "SOMERSET BOWEL CANCER SCREENING CENTRE"
}
]
Optionally Resource reference can be provided. This is required in the current version of EPS but this will be changed to supporting the identifier reference only.
"healthcareService":
[
{
"reference": "urn:uuid:54b0506d-49af-4245-9d40-d7d64902055e",
"identifier": {
"system": "https://fhir.nhs.uk/Id/ods-organization-code",
"value": "A99968"
}
"display": "SOMERSET BOWEL CANCER SCREENING CENTRE"
}
]
Constraints
- nhsd-4 (ERROR) PractitionerRole.healthcareService - An identifier reference or resource reference must be provided
telecom
Definition
At least one telecom number MUST be provided.
Contact details that are specific to the role/location/service. Often practitioners have a dedicated line for each location (or service) that they work at and need to be able to define separate contact details for each of these.
This is not the personnel contact number of the Practitioner, it the contact number for the practitioner in this role and may be the phone number of the clinic, main or branch surgery.
"telecom": [
{
"system": "phone",
"value": "01234567890",
"use": "work"
}
]
Requirements
Often practitioners have a dedicated line for each location (or service) that they work at, and need to be able to define separate contact details for each of these.