NHS England FHIR Implementation Guide (deprecated)

Important Announcement regarding this Implementation Guide
  • As of 04/10/2023, this implementation guide has been deprecated and all development on the legacy NHS England FHIR Implementation Guide assets has ceased.
  • Therefore, vendors looking to start new implementations or looking to update existing implementations should use the new NHS England Implementation Guide. Vendors continuing to implement legacy NHS England FHIR Implementation Guide based solutions do so at their own risk and on the understanding that no maintenance or support will be available.

NamingSystems

Official Catalogues of OIDS in the UK

HL7 UK OID Catalogue

NPfIT OID Catalogue

Name Type Kind Unique IDs Description Usage
UKchinumber N/A Identifier
oid 2.16.840.1.113883.2.1.3.2.4.16.53
Community Health Index Number allocated to the patient in Scotland. [CHI Number](https://www.datadictionary.nhs.uk/data_dictionary/attributes/c/com/community_health_index_number_de.asp) A patient identifier for everyone registered with the NHS in Scotland.
NhsMHSID N/A Identifier
uri https://fhir.nhs.uk/Id/nhsMhsID
NHS Message Handling System Identifier NHS Message Handling System Identifier
NhsServiceInteractionId N/A Identifier
uri https://fhir.nhs.uk/Id/nhsServiceInteractionId
NHS Service Interaction Identifier NHS Service Interaction Identifier
READV3 N/A Codesystem
uri http://read.info/ctv3
Read Codes version 3 - ctv3 UK Primary Care
UKdinnumber N/A Identifier
uri https://fhir.hl7.org.uk/Id/din-number
NHS Digital A unique reference number, used to identify consultants
DispensingSitePreferencens N/A Codesystem
uri https://fhir.nhs.uk/CodeSystem/dispensing-site-preference
oid 2.16.840.1.113883.2.1.3.2.4.17.21
Describes the nature of the role played by an agent (in this case a pharmacy) when supplying medication. Note: 1) Message coding reflects the PDS code scheme for P1R2. 2) The role of Agent is a place holder, not an actual specified pharmacy EPS
DMexemptionevidencens N/A Codesystem
uri https://fhir.nhs.uk/CodeSystem/DM-exemption-evidence
Exemption evidence seen. Code ES in 2.16.840.1.113883.2.1.3.2.4.17.30 EPS
DMmedicationdispenseprescriptionstatusns N/A Codesystem
uri https://fhir.nhs.uk/CodeSystem/EPS-task-business-status
oid 2.16.840.1.113883.2.1.3.2.4.16.35
EPS prescription status EPS
DMmedicationrequestStatusDispenseReasonns N/A Codesystem
uri https://fhir.nhs.uk/CodeSystem/medicationrequest-dispense-return-reason
oid 2.16.840.1.113883.2.1.3.2.4.16.28
Describes reasons for returning a prescription rather than dispensing it. EPS
DMprescriptionchargens N/A Codesystem
uri https://fhir.nhs.uk/CodeSystem/DM-prescription-charge
Prescription Charge Paid. Code CP in 2.16.840.1.113883.2.1.3.2.4.17.30 EPS
DMprescriptiontreatmenttypens N/A Codesystem
uri https://fhir.nhs.uk/CodeSystem/DM-prescription-treatment-type
oid 2.16.840.1.113883.2.1.3.2.4.16.36
The management reasons for a prescription being issued. EPS
EPStaskprescriptionreleaserejectionreasonns N/A Codesystem
uri https://fhir.nhs.uk/ConceptMap/Prescription-release-rejection-reason-EPS-IssueCode
oid 2.16.840.1.113883.2.1.3.2.4.16.34
EPS prescription status EPS
ERSAlternativeSlot N/A Identifier
uri https://fhir.nhs.uk/CodeSystem/unique-slot-reference-number
PAS systems unique reference for the slot provided by the provider (only present when there is a current appointment booking to a Directly Bookable Service) N/A
ERSservice N/A Identifier
uri https://fhir.nhs.uk/Id/ers-service
eRS HealthcareService Identifier N/A
ERSUBRN N/A Identifier
uri https://fhir.nhs.uk/Id/UBRN
oid 2.16.840.1.113883.2.1.3.2.4.1
Unique Booking Reference Number N/A
ERShealthcareserice N/A Identifier
uri https://fhir.nhs.uk/Id/ers-service
identifier of a healthcare service in eRS EPS
UKgdcnumber N/A Identifier
uri https://fhir.hl7.org.uk/Id/gdc-number
General Dental Council A unique reference number, used to identify consultants
UKgmcnumber N/A Identifier
uri https://fhir.hl7.org.uk/Id/gmc-number
oid 2.16.840.1.113883.2.1.3.2.4.16.63
uri GMC
General Medical Council Consultant Code. See [NHS Data Dictionary](https://www.datadictionary.nhs.uk/data_dictionary/attributes/g/general_medical_practitioner_ppd_code_de.asp) A unique consultant code, used to identify consultants
UKgmpnumber N/A Identifier
uri https://fhir.hl7.org.uk/Id/gmp-number
oid 2.16.840.1.113883.2.1.3.2.4.16.62
uri GMP
General Practitioner (GMP) number. See [NHS Data Dictionary](https://www.datadictionary.nhs.uk/data_dictionary/attributes/g/general_medical_practitioner_ppd_code_de.asp) A unqiue reference number normally used to identify GP's.
UKgphcnumber N/A Identifier
uri https://fhir.hl7.org.uk/Id/gphc-number
General Pharmaceutical Council number A unique reference number, used to identify pharmacists
UKhcpcnumber N/A Identifier
uri https://fhir.hl7.org.uk/Id/hcpc-number
Health and Care Professions Council A unique reference number, used to identify consultants
ICD10uk N/A Codesystem
uri http://hl7.org/fhir/sid/icd-10
International Statistical Classification of Diseases and Related Health Problems - 10th Edition UK Secondary Care - Condition
ICD11uk N/A Codesystem
uri http://hl7.org/fhir/sid/icd-11
International Statistical Classification of Diseases and Related Health Problems - 11th Edition UK Secondary Care - Condition
Medicationdispenseendorsementns N/A Codesystem
uri https://fhir.nhs.uk/CodeSystem/medicationdispense-endorsement
oid 2.16.840.1.113883.2.1.3.2.4.16.29
Dispensing Endorsement EPS
EPS prescription status N/A Codesystem
uri https://fhir.nhs.uk/CodeSystem/EPS-task-status-reason
oid 2.16.840.1.113883.2.1.3.2.4.16.35
EPS prescription status EPS
Medicationdispensetype N/A Codesystem
uri https://fhir.nhs.uk/CodeSystem/medicationdispense-type
oid 2.16.840.1.113883.2.1.3.2.4.17.23
medicationdispense type EPS
Prescriptionendorsementns N/A Codesystem
uri https://fhir.nhs.uk/CodeSystem/medicationrequest-endorsement
oid 2.16.840.1.113883.2.1.3.2.4.16.32
NHS BSA Prescription Endorsement EPS
DMmedicationrequeststatushistoryns N/A Codesystem
uri https://fhir.nhs.uk/CodeSystem/medicationrequest-status-history
oid 2.16.840.1.113883.2.1.3.2.4.17.19
Describes the status of the prescription cancellation EPS
DMmedicationrequeststatusreasonns N/A Codesystem
uri https://fhir.nhs.uk/CodeSystem/medicationrequest-status-reason
oid 2.16.840.1.113883.2.1.3.2.4.16.27
Clinical reason for the cancellation EPS
NHSBSAspuriouscode N/A Identifier
uri https://fhir.hl7.org.uk/Id/nhsbsa-spurious-code
NHS Business Services Authority (NHSBSA) A unique reference number, used to identify consultants
NhsEndpointServiceId N/A Identifier
uri https://fhir.nhs.uk/Id/nhsEndpointServiceId
NHS Endpoint Service Identifier NHS Endpoint Service Identifier
NhsMhsCPAId N/A Identifier
uri https://fhir.nhs.uk/Id/nhsMhsCPAId
NHS Message Handling Service (Cancel) Patient Appointment Identifier NHS Message Handling Service(Cancel) Patient Appointment Identifier
NhsMhsEndPoint N/A Identifier
uri https://fhir.nhs.uk/Id/nhsMhsEndPoint
NNHS Message Handling Service End Point NHS Message Handling Service End Point
NhsMhsFQDN N/A Identifier
uri https://fhir.nhs.uk/Id/nhsMhsFQDN
NHS Message Handling Service Fully Qualified Domain Name NHS Message Handling Service Fully Qualified Domain Name
NhsMhsPartyKey N/A Identifier
uri https://fhir.nhs.uk/Id/nhsMhsPartyKey
NHS Message Handling Service Party Key NHS Message Handling Service Party Key
UKnhsnumber N/A Identifier
uri https://fhir.nhs.uk/Id/nhs-number
oid 2.16.840.1.113883.2.1.4.1
uri NHS
NHS Number allocated to the patient in England and Wales . [NHS Number](https://www.datadictionary.nhs.uk/data_dictionary/attributes/n/nhs/nhs_number_de.asp) A unique patient identifier for everyone registered with the NHS in England and Wales.
NhsSpineASID N/A Identifier
uri https://fhir.nhs.uk/Id/nhsSpineASID
NHS Spine Accredited System Identifier NHS Spine Accredited System Identifier
UKnmcnumber N/A Identifier
uri https://fhir.hl7.org.uk/Id/nmc-number
Nursing and Midwifery Council A unique reference number, used to identify consultants
NPfITprofessionalcode N/A Identifier
uri https://fhir.hl7.org.uk/Id/professional-code
oid 1.2.826.0.1285.0.2.1.54
General code system for ODS Identifier (also known as NACS Practitioner Code) This system has been been retired in favour of individual systems which represent GMP Codes, Consultant Codes, etc.
ODSorganizationcode N/A Identifier
uri https://fhir.nhs.uk/Id/ods-organization-code
oid 2.16.840.1.113883.2.1.4.3
oid 1.2.826.0.1285.0.1.10
The identifier system for an Organisation registered with the Organisation Data Service (ODS). To be used to identify an Organisation registered with the Organisation Data Service (ODS).
ODSsitecode N/A Identifier
uri https://fhir.nhs.uk/Id/ods-site-code
The identifier system for an Organisation site registered with the Organisation Data Service (ODS). To be used to identify Organisation sites registered with the Organisation Data Service (ODS).
OPCS4 N/A Codesystem
uri https://fhir.nhs.uk/Id/opcs-4
OPCS Classification of Interventions and Procedures version 4 UK Secondary Care - Procedures and Interventions
MIMorganizationtypens N/A Codesystem
uri https://fhir.nhs.uk/CodeSystem/mim-organisation-type
oid 2.16.840.1.113883.2.1.3.2.4.17.94
The code system for an Organisation type with the Organisation Data Service (ODS). To be used to identify an Organisation registered with the Organisation Data Service (ODS).
Prescriptionordernumberuuidns N/A Identifier
uri https://fhir.nhs.uk/Id/prescription
This is the uuid of the grouped MedicationReqests equivalent of ParentPrescription.id in EPS HL7v3 EPS
Prescriptionannotationns N/A Codesystem
uri https://fhir.hl7org.uk/CodeSystem/prescription-annotation
oid 2.16.840.1.113883.2.1.3.2.4.17.30
Annotation and observation types relevant to a prescription. EPS
Prescriptionchargeexemptionns N/A Codesystem
uri https://fhir.nhs.uk/CodeSystem/prescription-charge-exemption
oid 2.16.840.1.113883.2.1.3.2.4.16.33
Prescription Charge Exemption. EPS
Prescriptionorderitemnumber N/A Identifier
uri https://fhir.nhs.uk/Id/prescription-order-item-number
This is the id of the prescription order item and is the same as the id found in pertinentInformation2[0].pertinentLineItem.id EPS
Prescriptionordernumberns N/A Identifier
uri https://fhir.nhs.uk/Id/prescription-order-number
oid 2.16.840.1.113883.2.1.3.2.4.18.8
The short form UID of the prescription. EPS
Prescriptiontypens N/A Codesystem
uri https://fhir.nhs.uk/CodeSystem/prescription-type
oid 2.16.840.1.113883.2.1.3.2.4.17.25
Describes the type of prescription this is. EPS
READV2 N/A Codesystem
uri http://read.info/readv2
Read Codes version 2 UK Primary Care
SnomedCT N/A Codesystem
uri http://snomed.info/sct
oid 2.16.840.1.113883.6.96
oid 2.16.840.1.113883.2.1.3.2.4.15
SNOMED CT UK
SDSroleprofilecode N/A Identifier
uri https://fhir.nhs.uk/Id/sds-role-profile-id
oid 1.2.826.0.1285.0.2.0.67
The user's role id on the NHS Spine Directory Service. To uniquely identify a users role in NHS Spine Directory Service.
SDSuserid N/A Identifier
uri https://fhir.nhs.uk/Id/sds-user-id
oid 1.2.826.0.1285.0.2.0.65
The user's unique identifier on the NHS Spine Directory Service. To uniquely identify a user of the NHS Spine Directory Service.
Spineasid N/A Identifier
uri https://fhir.nhs.uk/Id/spine-ASID
oid 1.2.826.0.1285.0.2.0.107
The user's unique identifier on the NHS Spine Directory Service. To uniquely identify a user of the NHS Spine Directory Service.
Prescriptiontherapytypens N/A Codesystem
uri https://fhir.hl7org.uk/CodeSystem/UKCore-PrescriptionType
The management reasons for a prescription being issued. See prescription-treatment-type for HL7v3 version Medication Management
UKcoreprescriptiontypens N/A Codesystem
uri https://fhir.hl7.org.uk/CodeSystem/UKCore-PrescriptionType
uri https://fhir.hl7.org.uk/STU3/CodeSystem/CareConnect-PrescriptionType-1
The management reasons for a prescription being issued. EPS
SDSjobroleid N/A Codesystem
uri https://fhir.hl7.org.uk/CodeSystem/UKCore-SDSJobRoleName
uri https://fhir.nhs.uk/CodeSystem/NHSDigital-SDS-JobRoleCode
oid 1.2.826.0.1285.0.2.1.104
The user's role id on the NHS Spine Directory Service (SmartCard/CIS2). The UKCore version has been retired, the NHS Digital version should now be used instead. To uniquely identify a users role in NHS Spine Directory Service.
UKgmcreferencenumber N/A Identifier
uri https://fhir.hl7.org.uk/Id/gmc-reference-number
oid 2.16.840.1.113883.2.1.3.2.4.18.29
General Medical Council Reference Number. See [NHS Data Dictionary](https://www.datadictionary.nhs.uk/attributes/general_medical_council_reference_number.html) A unique reference number, used to identify consultants
UKnhsloginsub N/A Identifier
uri https://fhir.nhs.uk/Id/nhs-login-sub
NHS Login unique identifer which is referred to as sub in NHS Login (OpenID) NHS Login

back to top