What are 'Roles' in ODS data?
Primary Roles
- Every Organisation or Site entity/record within health and social care organisation reference data must have at least one Role
- One (and only one) role per record must be classified as a Primary Role
- The Primary Role describes the organisation type - the fundamental nature of the entity/record and its overarching remit – for example ‘Pharmacy’, ‘NHS Trust’, ‘Optical Site’ etc
Non Primary Roles
- Non Primary Roles may be assigned to a record to provide further information about that Organisation’s functions or remit. For example, an NHS Trust site (Primary Role) that may be a Hospice or Treatment Centre (indicated via a Non Primary Role).
- Non-Primary Roles for an organisation or site are non-mandatory and are unrestricted in number
- The non primary roles that each primary role (organisation type) can have, are detailed within the corresponding organisation type definition page in this catalogue.
A list of all roles, with their role IDs and role names, and whether they are primary or non primary can be viewed via the ODS ORD API CodeSystem endpoint
Role Data Attributes
|
Master Data Attribute (ODS Internal Reference) |
Attribute Type | Length | Nullable |
Description / Notes |
Mapping to ODS Data Search & Export field (excluding predefined reports) |
Mapping to ORD API (ORD schema containers, elements and attributes) |
Mapping to ODS STU3 API |
Mapping to ODS FHIR R4 API Please refer to ODS FHIR R4 Implementation Guide and the OAS Specification |
|||||
| Organization Resource | ods-organisation-code CodeSystem |
organization-role-instance CodeSystem |
organization-relationship-instance CodeSystem |
ODSOrganisationRole CodeSystem | |||||||||
| UniqueRoleID | [nvarchar] | 255 | NOT NULL | Unique ID for each role record | Not available | Roles.Role.uniqueRoleId |
extension: https://fhir.nhs.uk/England/StructureDefinition/Extension-England-OrganisationRole instanceID |
Not available |
concept.code |
Not available |
Not available |
||
| OrganisationCode | [nvarchar] | 12 | NOT NULL |
Code (for the org record you are viewing) |
Organisation.OrgId.extension | identifier.value (also id) | identifier | concept.code | property.orgCode |
Not available |
|||
| RoleID | [nvarchar] | 10 | NOT NULL | i.e. RO190 | If primary: |
Primary Role ID |
Roles.Role.id Where: Roles.Role.primaryRole = True |
extension: https://fhir.nhs.uk/STU3/StructureDefinition/Extension-ODSAPI-OrganizationRole-1 role.coding.code |
extension:
https://fhir.nhs.uk/England/StructureDefinition/Extension-England-OrganisationRole instanceID.Coding.code |
property.role.Coding.code |
Property.role.Coding.code |
property.sourceOrgRole.coding.code system:https://digital.nhs.uk/services/organisation-data-service/CodeSystem/ODSOrganisationRole (active only) |
concept.code |
|
If non primary: |
Non Primary Role ID(s) |
Roles.Role.id (Roles.Role.primaryRole attribute is not present for non primary roles) |
extension: https://fhir.nhs.uk/STU3/StructureDefinition/Extension-ODSAPI-OrganizationRole-1 role.coding.code |
extension:
https://fhir.nhs.uk/England/StructureDefinition/Extension-England-OrganisationRole instanceID.Coding.code |
property.role (active only) |
Property.role.Coding.code |
property.sourceOrgRole.coding.code system:https://digital.nhs.uk/services/organisation-data-service/CodeSystem/ODSOrganisationRole (active only) |
concept.code | |||||
| RoleName | [nvarchar] | 100 | NOT NULL | If primary: |
Primary Role Name |
Lookup via OrganisationRole CodeSystem https://directory.spineservices.nhs.uk/ORD/2-0-0/roles? Roles.Role.displayName |
extension: https://fhir.nhs.uk/STU3/StructureDefinition/Extension-ODSAPI-OrganizationRole-1 role.coding.display |
extension:
https://fhir.nhs.uk/England/StructureDefinition/Extension-England-OrganisationRole instanceID.Coding.display |
Not available |
Not available |
Not available |
concept.display | |
| If non primary: |
Non Primary Role Name(s) |
Lookup via OrganisationRole CodeSystem https://directory.spineservices.nhs.uk/ORD/2-0-0/roles? Roles.Role.displayName |
extension: https://fhir.nhs.uk/STU3/StructureDefinition/Extension-ODSAPI-OrganizationRole-1 role.coding.display |
extension:
https://fhir.nhs.uk/England/StructureDefinition/Extension-England-OrganisationRole instanceID.Coding.display |
Not available |
Not available |
Not available |
concept.display | |||||
| OperationalStartDate | [nvarchar] | 8 | NULL |
Operational Start Date (for primary role) or Non Primary Role Operational Start Date |
Roles.Role.Date.Start Where: Roles.Role.Date.Type = Operational |
extension: https://fhir.nhs.uk/STU3/StructureDefinition/Extension-ODSAPI-OrganizationRole-1 role.activePeriod.start (Operational) |
Extension: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-TypedPeriod dateType Whether the Date Period is 'Legal' or 'Operational'. period Start: where Type=dateTime period.start (Operational) |
Not available |
property.opStartDate |
Not available |
Not available |
||
| OperationalEndDate | [nvarchar] | 8 | NULL |
Operational End Date (for primary role) or Non Primary Role Operational End Date |
Roles.Role.Date.End Where: Roles.Role.Date.Type = Operational |
extension: https://fhir.nhs.uk/STU3/StructureDefinition/Extension-ODSAPI-OrganizationRole-1 role.activePeriod.end (Operational) |
Extension: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-TypedPeriod dateType Whether the Date Period is 'Legal' or 'Operational'. period End: where Type=dateTime period.end (Operational) |
Not available |
property.opEndDate |
Not available |
Not available |
||
| LegalStartDate | [nvarchar] | 8 | NULL |
Legal Start Date (for primary role) of Non Primary Role Legal Start Date |
Roles.Role.Date.Start Where: Roles.Role.Date.Type = Legal |
extension: https://fhir.nhs.uk/STU3/StructureDefinition/Extension-ODSAPI-OrganizationRole-1 role.activePeriod.start (Legal) |
Extension: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-TypedPeriod dateType Whether the Date Period is 'Legal' or 'Operational'. period Start: where Type=dateTime period.start (Legal) |
Not available |
property.legStartDate |
Not available |
Not available |
||
| LegalEndDate | [nvarchar] | 8 | NULL |
Legal End Date (for primary role) or Non Primary Role Legal End Date |
Roles.Role.Date.End Where: Roles.Role.Date.Type = Legal |
extension: https://fhir.nhs.uk/STU3/StructureDefinition/Extension-ODSAPI-OrganizationRole-1 role.activePeriod.end (Legal) |
Extension: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-TypedPeriod dateType Whether the Date Period is 'Legal' or 'Operational'. period End: where Type=dateTime period.end (Legal) |
Not available |
property.legEndDate |
Not available |
Not available |
||
| Status | [varchar] | 8 | NOT NULL | inactive if both legal and operational end dates are present and the end dates are both equal to or before today’s date. |
Not available (Role Status not available via DSE, only overall organisation status) |
Roles.Role.Status |
extension: https://fhir.nhs.uk/STU3/StructureDefinition/Extension-ODSAPI-OrganizationRole-1 status |
Extension: https://fhir.nhs.uk/England/StructureDefinition/Extension-England-OrganisationRole active (boolean) |
only active roles included | property.inactive |
only active roles included |
Not available |
|
| PrimaryRole | Bit | NOT NULL | 1 (TRUE),0 (FALSE) |
No primary role flag, but Primary Role ID and Primary Role name are displayed within DSE as distinct attributes so a primary role flag is not required |
Roles.Role.primaryRole = True |
extension: https://fhir.nhs.uk/STU3/StructureDefinition/Extension-ODSAPI-OrganizationRole-1 primaryRole |
role.PrimaryRole (boolean) |
Not available |
property.primaryRole |
Not available |
property.primaryRole | ||
Primary Role IDs and Names
| RoleID | Role Name | Legacy/Closed Role in ODS? | Notes |
| RO89 | EXECUTIVE AGENCY PROGRAMME - DEPARTMENT | Open | |
| RO90 | EXECUTIVE AGENCY SITE | Open | |
| RO91 | EXECUTIVE AGENCY PROGRAMME | Open | |
| RO92 | APPLICATION SERVICE PROVIDER | Open | |
| RO93 | APPLICATION SERVICE PROVIDER - LEGACY | Open | |
| RO94 | APPLIANCE CONTRACTOR | Open | |
| RO96 | BRANCH SURGERY | Open | |
| RO98 | CLINICAL COMMISIONING GROUP | Open | Includes Sub ICB Locations and Clinical Commissioning Groups and Commissioning Hubs (identified via non primary roles). |
| RO99 | CLINICAL COMMISSIONING GROUP SITE | Open | Sub ICB Location' Sites. |
| RO101 | SOCIAL CARE SITE | Open | Renamed Social Care Site Nov18, previously Care Home Site. New non primary role introduced for Care Home (RO269). |
| RO102 | CLINICAL NETWORK | Open | Includes Clinical Networks; Cardiac/Heart/Stroke/Cardiovascular/Critical Care Networks. |
| RO103 | CANCER NETWORK | Open | Includes Cancer Network; Cancer Alliance; Cancer Commissioning Team; Strategic Clinical Network. |
| RO104 | SOCIAL CARE PROVIDER | Open | Renamed Social Care Provider Nov18, previously Care Home HQ. New non primary role introduced for Care Home (RO269). |
| RO105 | CANCER REGISTRY | Open | Includes Cancer Registries/Information Centre/Intelligence Services |
| RO106 | COMMON SERVICE AGENCY (CSA) | Legacy/Closed |
|
| RO107 | CARE TRUST | Open | |
| RO108 | CARE TRUST SITE | Open | |
| RO109 | DISTRICT HEALTH AUTHORITY | Legacy/Closed |
|
| RO110 | GENERAL DENTAL PRACTICE | Open | |
| RO111 | DIRECTLY MANAGED UNIT (DMU) | Legacy/Closed |
|
| RO114 | DMU SITE | Legacy/Closed |
|
| RO116 | EXECUTIVE AGENCY | Open | |
| RO117 | EDUCATION | Open | Includes Deanery and Health Education. |
| RO119 | LOCAL AUTHORITY - LEGACY | Legacy/Closed |
|
| RO122 | LOCAL AUTHORITY SITE - LEGACY | Legacy/Closed |
|
| RO123 | LOCAL AUTHORITY DEPARTMENT | Legacy |
|
| RO126 | GOVERNMENT DEPARTMENT | Open | |
| RO128 | GOVERNMENT OFFICE REGION | Open | |
| RO131 | GOVERNMENT DEPARTMENT SITE | Open | |
| RO132 | HEALTH AUTHORITY (HA) | Legacy | Includes Health Authority; Strategic Health Authority. |
| RO134 | HEALTH OBSERVATORY | Open | |
| RO136 | STRATEGIC HEALTH AUTHORITY SITE | Legacy |
|
| RO137 | ISLE OF MAN GOVERNMENT DIRECTORATE | Open | A generic naming convention has been applied to this type. Includes Isle of Man Primary Healthcare; Public Health; Secondary Healthcare. |
| RO138 | ISLE OF MAN GOVERNMENT DEPARTMENT | Open | A generic naming convention has been applied to this type. Includes Isle of Man Health Directorate. |
| RO140 | ISLE OF MAN GOVERNMENT DIRECTORATE SITE | Open | A generic naming convention has been applied to this type. Includes Isle of Man Cottage Hospital; Hospital; Ambulance Service; Office/Headquarters. |
| RO141 | LOCAL AUTHORITY | Open | |
| RO142 | LOCAL HEALTH BOARD | Open | Current primary role for Local Health Boards in Wales |
| RO144 | WELSH LOCAL HEALTH BOARD | Legacy/Closed |
|
| RO146 | LOCAL SERVICE PROVIDER (LSP) | Open | |
| RO147 | LSP SITE | Open | |
| RO148 | LOCAL HEALTH BOARD SITE | Open | Current primary role for Local Health Board Sites in Wales |
| RO149 | WELSH LOCAL HEALTH BOARD SITE | Legacy/Closed |
|
| RO150 | MILITARY HOSPITAL | Open | |
| RO153 | NORTHERN IRELAND HEALTH & SOCIAL CARE BOARD | Open | |
| RO154 | NORTHERN IRELAND HEALTH AND SOCIAL CARE TRUST | Open | |
| RO155 | NORTHERN IRELAND LOCAL COMMISSIONING GROUP | Open | |
| RO157 | NON-NHS ORGANISATION | Open | |
| RO158 | NON STATUTORY NHS ORGANISATION | Open | |
| RO159 | NATIONAL APPLICATION SERVICE PROVIDER | Open | |
| RO161 | NHS SUPPORT AGENCY | Open | Includes Shared Services/Consortium/Partnership, Informatics Services, Specialised Commissioning Group, LCCB, Support Services. |
| RO162 | OTHER STATUTORY AUTHORITY (OSA) | Open | |
| RO166 | OPTICAL HEADQUARTERS | Open | |
| RO167 | OPTICAL SITE | Open | |
| RO168 | OTHER STATUTORY AUTHORITY SITE | Open | |
| RO170 | OXYGEN CONCENTRATOR SUPPLIER | Legacy/Closed |
|
| RO171 | PRIMARY CARE GROUP | Legacy/Closed |
|
| RO172 | INDEPENDENT SECTOR HEALTHCARE PROVIDER | Open | |
| RO173 | PATHOLOGY LAB | Open | |
| RO175 | PRISON | Open | |
| RO176 | INDEPENDENT SECTOR H/C PROVIDER SITE | Open | |
| RO177 | PRESCRIBING COST CENTRE | Open | Includes GP Practice prescribing cost centres |
| RO179 | PRIMARY CARE TRUST | Legacy |
|
| RO180 | PRIMARY CARE TRUST SITE | Legacy |
|
| RO181 | PHARMACY HEADQUARTERS | Open | |
| RO182 | PHARMACY | Open | Also known as Dispensary. |
| RO185 | REGIONAL OFFICE (RO) | Open | |
| RO189 | SPECIAL HEALTH AUTHORITY (SPHA) | Open | |
| RO190 | SCOTTISH HEALTH BOARD | Open | |
| RO191 | SPECIAL HEALTH AUTHORITY SITE | Open | |
| RO195 | TRANSPLANT CONSORTIUM (TC) | Legacy/Closed |
|
| RO197 | NHS TRUST | Open | |
| RO198 | NHS TRUST SITE | Open | |
| RO200 | WELSH ASSEMBLY | Open | |
| RO203 | WELSH HEALTH COMMISSION | Legacy/Closed |
|
| RO204 | WELSH REGIONAL OFFICE | Legacy/Closed |
|
| RO209 | NHS ENGLAND (REGION) | Open | Previously known as NHS England Commissioning Region. Updated following request from NHS England May17. |
| RO210 | NHS ENGLAND (REGION, LOCAL OFFICE) | Open | Previously known as Region (Geography). Updated following request from NHS England May17. |
| RO212 | NHS ENGLAND (REGION, LOCAL OFFICE) SITE | Open | Previously known as Region (Geography) Site. Updated following request from NHS England May17. |
| RO213 | COMMISSIONING SUPPORT UNIT | Open | |
| RO214 | COMMISSIONING SUPPORT UNIT SITE | Open | |
| RO216 | DATA SERVICES FOR COMMISSIONERS REGIONAL OFFICE (DSCRO) | Open | Previously 'Data Management and Integration Centre (DMIC)'. |
| RO217 | DSCRO SITE | Open | Previously 'DMIC Site'. |
| RO221 | SCHOOL | Open | |
| RO222 | LOCAL AUTHORITY SITE | Open | |
| RO227 | SCOTTISH GP PRACTICE | Open | |
| RO228 | YOUTH OFFENDER INSTITUTION | Open | |
| RO230 | SECURE TRAINING CENTRE | Open | |
| RO231 | SECURE CHILDREN'S HOME | Open | |
| RO232 | IMMIGRATION REMOVAL CENTRE | Open | |
| RO233 | CONSTABULARY | Open | |
| RO234 | POLICE CUSTODY SUITE | Open | |
| RO235 | COURT | Open | |
| RO236 | SEXUAL ASSAULT REFERRAL CENTRE | Open | |
| RO261 | STRATEGIC PARTNERSHIPS | Open | Includes Integrated Care Boards (ICBs) |
| RO272 | PRIMARY CARE NETWORK | Open | |
| RO280 | PHARMACY SITES | Open | Includes COVID Vaccination Sites operated by Pharmacies |
| RO315 | NORTHERN IRELAND GP PRACTICE | Open | |
| RO322 | NORTHERN IRELAND NON-HPSS PROVIDER/ORGANISATION | Open |
