RTS Value Sets

Value sets are sub-groupings of codes within the code systems in RTS.  The code systems are equivalent to the OID (OIDs are the second half of the RTS identifier).

For instance, the code system for ODS organisations is "2.16.840.1.113883.2.1.3.2.4.18.48".  If a user were to query the API and ask for all RTS organisation type codes using this OID to be returned, that would return all values within the code system (all organisation types).  

However, that may not be specific enough to return the data that is actually required.  In that case, the RTS Data Management team could create a value set within the code system which would allow users to specify only those codes that denote the types of Care Home, for instance.  This would allow the user to request all the organisation type codes for Care Homes to be returned as set, instead of having to sort through all values in the code system to find them. 

Value sets in RTS are preceded by an underscore, to differentiate them from ordinary terms in the Termset.  Currently, users calling the API can find the following value sets in RTS:

• • _CPMS_ORG_TYPE@2.16.840.1.113883.2.1.3.8.5.11.1.106 - Returns all organisation types used in CPMS

  • _CPMS_ORG_ROLE_TYPE@2.16.840.1.113883.2.1.3.8.5.11.1.107 - Returns all organisation roles used in CPMS

  • _CPMS_SITE_TYPE@2.16.840.1.113883.2.1.3.8.5.11.1.106 - Returns all site types used in CPMS

  • _NHSDigital_ODS_Relationships@2.16.840.1.113883.2.1.3.2.4.17.508 - Returns all relationship types in the ODS data set (part of new API data service)

  • _NHSDigital_ODS_Roles@2.16.840.1.113883.2.1.3.2.4.17.507 - Returns all role types in the ODS data set (part of new API data service)

  • _NHSDigital_ODS_Roles_Primary@2.16.840.1.113883.2.1.3.2.4.17.507 - Returns all primary role types in the ODS data set (part of new API data service).  Primary roles are similar to CPMS organisation types, primary roles are mandatory and organisations may only have one.

  • _NHSDigital_ODS_Roles_NonPrimary@2.16.840.1.113883.2.1.3.2.4.17.507 - Returns all non-primary role types in the ODS data set (part of new API data service).  Non-primary roles are not mandatory and organisations may have more than one.

Users will need to set up an account to access the RTS API in order to get access to the value sets in RTS.

The API call that will return the value sets is: 

[Base URL]/api/v1/Rts/GetTermsetList?parentIdentifier=_CPMS_SITE_TYPE@2.16.840.1.113883.2.1.3.8.5.11.1.106

* Please disregard all terms with the status of Terminated or Nullified, as these are not in active use in CPMS or RTS.

In order to request a new value set, please send an email to the CRNCC Data Management team explaining your request.