Created by Laura Reeves, last modified on Jul 18, 2024

 

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 TypeLengthNullableDescription / 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 Resourceods-organisation-code CodeSystem

organization-role-instance CodeSystem

organization-relationship-instance CodeSystem

ODSOrganisationRole CodeSystem
UniqueRoleID[nvarchar]255NOT NULLUnique ID for each role recordNot availableRoles.Role.uniqueRoleId

extension: https://fhir.nhs.uk/England/StructureDefinition/Extension-England-OrganisationRole

instanceID

Not available

concept.code

Not available

Not available

OrganisationCode[nvarchar]12NOT NULL

Code

(for the org record you are viewing)

Organisation.OrgId.extensionidentifier.value (also id)identifierconcept.codeproperty.orgCode

Not available

RoleID[nvarchar]10NOT NULLi.e. RO190If 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]100NOT 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]8NULL

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]8NULL

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]8NULL

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]8NULL

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]8NOT NULLinactive 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 includedproperty.inactive

only active roles included

Not available

PrimaryRoleBit
NOT NULL1 (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

RoleIDRole NameLegacy/Closed Role in ODS?Notes
RO89EXECUTIVE AGENCY PROGRAMME - DEPARTMENT  Open
RO90EXECUTIVE AGENCY SITE   Open
RO91EXECUTIVE AGENCY PROGRAMME  Open
RO92APPLICATION SERVICE PROVIDEROpen
RO93APPLICATION SERVICE PROVIDER - LEGACYOpen 
RO94APPLIANCE CONTRACTOR   Open
RO96BRANCH SURGERY    Open
RO98CLINICAL COMMISIONING GROUP  OpenIncludes Sub ICB Locations and Clinical Commissioning Groups and Commissioning Hubs (identified via non primary roles).
RO99CLINICAL COMMISSIONING GROUP SITE  OpenSub ICB Location' Sites.
RO101SOCIAL CARE SITE   OpenRenamed Social Care Site Nov18, previously Care Home Site. New non primary role introduced for Care Home (RO269).
RO102CLINICAL NETWORK  OpenIncludes Clinical Networks; Cardiac/Heart/Stroke/Cardiovascular/Critical Care Networks.
RO103CANCER NETWORK   OpenIncludes Cancer Network; Cancer Alliance; Cancer Commissioning Team; Strategic Clinical Network.
RO104SOCIAL CARE PROVIDEROpenRenamed Social Care Provider Nov18, previously Care Home HQ. New non primary role introduced for Care Home (RO269).  
RO105CANCER REGISTRY   OpenIncludes Cancer Registries/Information Centre/Intelligence Services
RO106COMMON SERVICE AGENCY (CSA)Legacy/Closed
RO107CARE TRUST   Open
RO108CARE TRUST SITE   Open
RO109DISTRICT HEALTH AUTHORITYLegacy/Closed
RO110GENERAL DENTAL PRACTICE   Open
RO111DIRECTLY MANAGED UNIT (DMU)Legacy/Closed
RO114DMU SITELegacy/Closed
RO116EXECUTIVE AGENCY   Open
RO117EDUCATION    OpenIncludes Deanery and Health Education.
RO119LOCAL AUTHORITY - LEGACYLegacy/Closed
RO122LOCAL AUTHORITY SITE - LEGACYLegacy/Closed
RO123LOCAL AUTHORITY DEPARTMENTLegacy
RO126GOVERNMENT DEPARTMENT    Open
RO128GOVERNMENT OFFICE REGION    Open
RO131GOVERNMENT DEPARTMENT SITE    Open
RO132HEALTH AUTHORITY (HA)    LegacyIncludes Health Authority; Strategic Health Authority.
RO134HEALTH OBSERVATORY     Open
RO136STRATEGIC HEALTH AUTHORITY SITE    Legacy
RO137ISLE OF MAN GOVERNMENT DIRECTORATE   OpenA generic naming convention has been applied to this type. Includes Isle of Man Primary Healthcare; Public Health; Secondary Healthcare.
RO138ISLE OF MAN GOVERNMENT DEPARTMENT  OpenA generic naming convention has been applied to this type. Includes Isle of Man Health Directorate.
RO140ISLE OF MAN GOVERNMENT DIRECTORATE SITE  OpenA generic naming convention has been applied to this type. Includes Isle of Man Cottage Hospital; Hospital; Ambulance Service; Office/Headquarters.
RO141LOCAL AUTHORITY     Open
RO142LOCAL HEALTH BOARD    OpenCurrent primary role for Local Health Boards in Wales
RO144WELSH LOCAL HEALTH BOARD    Legacy/Closed
RO146LOCAL SERVICE PROVIDER (LSP)     Open
RO147LSP SITE  Open
RO148LOCAL HEALTH BOARD SITE     OpenCurrent primary role for Local Health Board Sites in Wales
RO149WELSH LOCAL HEALTH BOARD SITE  Legacy/Closed
RO150MILITARY HOSPITAL     Open
RO153NORTHERN IRELAND HEALTH & SOCIAL CARE BOARD     Open
RO154NORTHERN IRELAND HEALTH AND SOCIAL CARE TRUST  Open
RO155NORTHERN IRELAND LOCAL COMMISSIONING GROUP     Open
RO157NON-NHS ORGANISATION  Open
RO158NON STATUTORY NHS ORGANISATION     Open
RO159NATIONAL APPLICATION SERVICE PROVIDER  Open
RO161NHS SUPPORT AGENCY    OpenIncludes Shared Services/Consortium/Partnership, Informatics Services, Specialised Commissioning Group, LCCB, Support Services.
RO162OTHER STATUTORY AUTHORITY (OSA)     Open
RO166OPTICAL HEADQUARTERS     Open
RO167OPTICAL SITE    Open
RO168OTHER STATUTORY AUTHORITY SITE     Open
RO170OXYGEN CONCENTRATOR SUPPLIERLegacy/Closed
RO171PRIMARY CARE GROUPLegacy/Closed
RO172INDEPENDENT SECTOR HEALTHCARE PROVIDER     Open
RO173PATHOLOGY LAB    Open
RO175PRISON Open
RO176INDEPENDENT SECTOR H/C PROVIDER SITEOpen
RO177PRESCRIBING COST CENTRE   OpenIncludes GP Practice prescribing cost centres
RO179PRIMARY CARE TRUST Legacy
RO180PRIMARY CARE TRUST SITE     Legacy
RO181PHARMACY HEADQUARTERSOpen
RO182PHARMACYOpenAlso known as Dispensary.
RO185REGIONAL OFFICE (RO)  Open
RO189SPECIAL HEALTH AUTHORITY (SPHA)  Open
RO190SCOTTISH HEALTH BOARD Open
RO191SPECIAL HEALTH AUTHORITY SITE Open
RO195TRANSPLANT CONSORTIUM (TC)   Legacy/Closed
RO197NHS TRUST  Open
RO198NHS TRUST SITE     Open
RO200WELSH ASSEMBLY    Open
RO203WELSH HEALTH COMMISSION    Legacy/Closed
RO204WELSH REGIONAL OFFICE    Legacy/Closed
RO209NHS ENGLAND (REGION)OpenPreviously known as NHS England Commissioning Region. Updated following request from NHS England May17.
RO210NHS ENGLAND (REGION, LOCAL OFFICE)OpenPreviously known as Region (Geography). Updated following request from NHS England May17.
RO212NHS ENGLAND (REGION, LOCAL OFFICE) SITEOpenPreviously known as Region (Geography) Site. Updated following request from NHS England May17.
RO213COMMISSIONING SUPPORT UNIT   Open
RO214COMMISSIONING SUPPORT UNIT SITE   Open
RO216DATA SERVICES FOR COMMISSIONERS REGIONAL OFFICE (DSCRO)   OpenPreviously 'Data Management and Integration Centre (DMIC)'.  
RO217DSCRO SITE   OpenPreviously 'DMIC Site'.  
RO221SCHOOL    Open
RO222LOCAL AUTHORITY SITE     Open
RO227SCOTTISH GP PRACTICE   Open
RO228YOUTH OFFENDER INSTITUTION     Open
RO230SECURE TRAINING CENTRE    Open
RO231SECURE CHILDREN'S HOME Open
RO232IMMIGRATION REMOVAL CENTRE    Open
RO233CONSTABULARY     Open
RO234POLICE CUSTODY SUITE     Open
RO235COURTOpen
RO236SEXUAL ASSAULT REFERRAL CENTRE Open
RO261STRATEGIC PARTNERSHIPSOpenIncludes Integrated Care Boards (ICBs)
RO272PRIMARY CARE NETWORKOpen
RO280PHARMACY SITESOpenIncludes COVID Vaccination Sites operated by Pharmacies
RO315NORTHERN IRELAND GP PRACTICEOpen
RO322NORTHERN IRELAND NON-HPSS PROVIDER/ORGANISATIONOpen

Attachments:

back.png (image/png)