The Data References for the Sh protocol are defined in the 3GPP TS 29.328 specification. The version of the specification in use is described in the Sh Cache Resource Adaptor Statement of Compliance
Each Data Reference defines a set of information stored in the HSS as well as the "key" to accessing it (called the Access key). Each Data Reference type has different Access Key definitions. These can be viewed in Table 7.6.1 of 29.328.
The Data Reference types and the access keys are:
Data reference | Access key |
---|---|
RepositoryData |
Data Reference + ( IMS Public User Identity OR Public Service Identity ) + Service Indication |
IMSPublicIdentity |
Data Reference + ( IMS Public User Identity OR Public Service Identity OR MSISDN ) + [ Requested Identity Set ] |
IMSUserState |
Data Reference + IMS Public User Identity |
S-CSCFName |
Data Reference + ( IMS Public User Identity OR Public Service Identity ) |
InitialFilterCriteria |
Data Reference + ( IMS Public User Identity OR Public Service Identity ) + Application Server Name |
LocationInformation |
Data Reference + ( IMS Public User Identity OR MSISDN ) + [ Private Identity ] + Requested Domain + Current Location + [ Serving Node Indication ] + [ Requested Nodes ] + [ Local Time Zone Indication ] |
UserState |
Data Reference + ( IMS Public User Identity OR MSISDN ) + [ Private Identity ] + Requested Domain + [ Requested Nodes ] |
Charging information |
Data Reference + ( IMS Public User Identity OR Public Service Identity OR MSISDN ) |
MSISDN or MSISDN + ExtendedMSISDN |
Data Reference + ( IMS Public User Identity OR MSISDN ) + [ Private Identity ] |
PSIActivation |
Data Reference + IMS Public Service Identity |
DSAI |
Data Reference + ( IMS Public User Identity OR Public Service Identity ) + DSAI Tag + Application Server Name |
ServiceLevelTraceInfo |
Data Reference + ( IMS Public User Identity OR MSISDN ) |
IP Address Secure Binding Information |
Data Reference + ( IMS Public User Identity ) |
Service Priority Level |
Data Reference + ( IMS Public User Identity ) |
SMSRegistrationInfo |
Data Reference + ( IMS Public User Identity OR MSISDN ) + [ Private Identity ] |
UE reachability for IP |
Data Reference + ( IMS Public User Identity OR MSISDN ) + [ Private Identity ] |
T-ADS Information |
Data Reference + ( IMS Public User Identity OR MSISDN ) + [ Private Identity ] |
STN-SR |
Data Reference + ( IMS Public User Identity OR MSISDN ) + [ Private Identity ] |
UE-SRVCC- Capability |
Data Reference + ( IMS Public User Identity OR MSISDN ) + [ Private Identity ] |
ExtendedPriority |
Data Reference + ( IMS Public User Identity OR MSISDN ) + [ Private Identity ] |
CSRN |
Data Reference + ( IMS Public User Identity OR MSISDN ) + [ Private Identity ] |
Reference Location Information |
Data Reference + ( IMS Public User Identity ) + [ Private Identity ] |
![]() |
When querying the HSS for MSISDN data, VoLTE by default sets the identity type to IMPU. When using the Sh Cache Rest Api to act on the MSISDN caches, set the identity type to IMPU |
Each Data Reference corresponds to logically distinct information in the HSS. The act of placing a Data Reference (and associated access key information) into a read Request to the HSS instructs the HSS to read the appropriate information and return it. A rough analogy is that a Data Reference might be considered a Database Table, and the Access Key the requested row in the table.
Some Data References allow the Application Server to read and write data stored in the HSS (for example Repository Data). Others allow read only (for example T-ADS information). For further details please refer to table 7.6.1 of 29.328.