6.2.6 Data Model

29.5623GPP5G SystemHome Subscriber Server (HSS) servicesRelease 18Stage 3TS

6.2.6.1 General

This clause specifies the application data model supported by the API.

Table 6.2.6.1-1 specifies the data types defined for the Nhss_imsSDM service API.

Table 6.2.6.1-1: Nhss_imsSDM specific Data Types

Data type

Clause defined

Description

ScscfCapabilityList

6.2.6.2.2

Information about mandatory and optional S-CSCF capabilities

ImsProfileData

6.2.6.2.4

User’s IMS profile data

RepositoryData

6.2.6.2.7

Repository Data for the requested Service Indication

MsisdnList

6.2.6.2.8

List of MSISDNs associated to the IMS public Identity

PublicIdentities

6.2.6.2.9

IMS Public Identities which belong to the same Implicit Registration Set (if any) as the requested IMS Public Identity

PublicIdentity

6.2.6.2.10

IMS Public Identity and the related data (Alias Group Id, IRS default indication, Identity Type)

ImsSdmSubscription

6.2.6.2.11

A subscription to notifications of data change

ImsRegistrationStatus

6.2.6.2.12

Registration status of the user.

PriorityLevels

6.2.6.2.13

Namespaces and priority levels allowed for the IMS public Identity.

Ifcs

6.2.6.2.14

List of IFCs associated to the IMS public Identity

Ifc

6.2.6.2.15

Data associated to an individual IFC (Initial Filter Criteria)

TriggerPoint

6.2.6.2.16

Contains the conditions that should be checked in order to find out if an Application Server should be contacted or not

Spt

6.2.6.2.17

Contains the data of a Service Point Trigger

HeaderSipRequest

6.2.6.2.18

Contains a header (and optionally value of the header) in the SIP request

SdpDescription

6.2.6.2.19

Contains a SDP line (and optionally the value in the line) within the body (if any) of a SIP request

ApplicationServer

6.2.6.2.20

Application Server which shall be triggered if the conditions of a certain IFC are met, and its associated data

ImsLocationData

6.2.6.2.21

IMS Location Data (S-CSCF name)

ServiceLevelTraceInformation

6.2.6.2.22

IMS Service Level Trace Information

PsLocation

6.2.6.2.23

Location data in PS domain.

SgsnLocationData

6.2.6.2.24

Location information as retrieved from the SGSN serving node

MmeLocationData

6.2.6.2.25

Location information as retrieved from the MME serving node

AmfLocationData

6.2.6.2.26

Location information as retrieved from the AMF serving node

TwanLocationData

6.2.6.2.27

Location information of the 3GPP AAA Server for Trusted W-LAN Access

CsLocation

6.2.6.2.28

Location data in CS domain.

CsgInformation

6.2.6.2.29

Information about a Closed Subscriber Group (CSG)

SrvccData

6.2.6.2.30

UE SRVCC capability (if available) and STN-SR (if subscribed)

PsiActivationState

6.2.6.2.31

Public Service Identity activation state

ImeiSvInformation

6.2.6.2.34

IMEI(SV) information

TadsInformation

6.2.6.2.36

T-ADS Information

UeReachabilitySubscription

6.2.6.2.37

A subscription to notifications of UE reachability for IP.

UeReachabilityNotification

6.2.6.2.38

A notification of UE reachability for IP.

PsUserState

6.2.6.2.39

User state in PS domain

CsUserState

6.2.6.2.40

User state in CS domain

Csrn

6.2.6.2.41

CS domain routeing number

ReferenceLocationInformation

6.2.6.2.42

Reference Location Information for the user in fixed access networks.

SmsRegistrationInfo

6.2.6.2.43

SMS Registration Information (IP-SM-GW number and SC address)

IpSmGwAddress

6.2.6.2.44

IP-SM-GW number and diameter URI/realm

ImsAssociatedIdentities

6.2.6.2.45

A list of identities belonging to the same Implicit Registration Set (IRS), along with the registration state of the IRS

DsaiTagInformation

6.2.6.2.46

DSAI tag information (list of DSAI tags activation state for an Application Server)

DsaiTagStatus

6.2.6.2.47

DSAI tag status (DSAI tag and activation state)

CreatedUeReachabilitySubscription

6.2.6.2.48

A subscription to notifications of UE reachability for IP.

PrivateIdentities

6.2.6.2.49

IMS Private Identities

PrivateIdentity

6.3.6.2.50

IMS Private Identity and the related data (e.g. Identity Type)

ScscfSelectionAssistanceInformation

6.2.6.2.51

Information used by the I-CSCF to select an S-CSCF for the UE

ChargingInfo

6.2.6.2.52

Diameter addresses of the charging function

RepositoryDataList

6.2.6.2.53

List of Repository Data for the requested Service Indications

CoreNetworkServiceAuthorization

6.2.6.2.54

Core Network Service Authorization

Table 6.2.6.1-2 specifies data types re-used by the Nhss_imsSDM service API from other specifications, including a reference to their respective specifications and when needed, a short description of their use within the Nhss_imsSDM.

Table 6.2.6.1-2: Nhss_imsSDM re-used Data Types

Data type

Reference

Comments

Uri

3GPP TS 29.571 [16]

Uniform Resource Identifier

SupportedFeatures

3GPP TS 29.571 [16]

see 3GPP TS 29.500 [4] clause 6.6

ModificationNotification

3GPP TS 29.503 [15]

Payload of the notification after a data change

EutraLocation

3GPP TS 29.571 [16]

E-UTRAN user location

NrLocation

3GPP TS 29.571 [16]

NR user location

PlmnId

3GPP TS 29.571 [16]

PLMN Identity

TimeZone

3GPP TS 29.571 [16]

Time Zone and Daylight Saving Time

UtraLocation

3GPP TS 29.571 [16]

UTRAN user location

GeraLocation

3GPP TS 29.571 [16]

GERAN user location

DiameterIdentity

3GPP TS 29.571 [16]

Diameter URI

NfInstanceId

3GPP TS 29.571 [16]

String uniquely identifying a NF instance

RatType

3GPP TS 29.571 [16]

RAT type

StnSr

3GPP TS 29.571 [16]

Session Transfer Number for SRVCC

PatchItem

3GPP TS 29.571 [16]

Patch Item

PatchResult

3GPP TS 29.571 [16]

Patch Result

IpAddr

3GPP TS 29.571 [16]

IP address (IPv4 address, IPv6 address, or IPv6 Prefix)

DateTime

3GPP TS 29.571 [16]

UTC time

AccessType

3GPP TS 29.571 [16]

Type of access

ProblemDetails

3GPP TS 29.571 [16]

Response body of error response messages.

RedirectResponse

3GPP TS 29.571 [16]

Response body of redirect response messages.

Ecgi

3GPP TS 29.571 [16]

E-UTRAN Cell Global Identity

Tai

3GPP TS 29.571 [16]

Tracking Area Identity

6.2.6.2 Structured data types

6.2.6.2.1 Introduction

This clause defines the structures to be used in resource representations.

6.2.6.2.2 Type: ScscfCapabilityList

Table 6.2.6.2.2-1: Definition of type ScscfCapabilityList

Attribute name

Data type

P

Cardinality

Description

mandatoryCapabilityList

Capabilities

O

1

List of S-CSCF capabilities which are mandatory to be supported by the S-CSCF allocated to the subscription the user belongs to.

optionalCapabilityList

Capabilities

O

1

List of S-CSCF capabilities which are optional or preferred (but not mandatory) to be supported by the S-CSCF allocated to the subscription the user belongs to.

NOTE 1: At least one of mandatory or optional capabilities shall be present.

6.2.6.2.3 Type: Capabilities

Table 6.2.6.2.3-1: Definition of type Capabilities

Type Name

Type Definition

Description

Capabilities

array(Capability)

This IE contains a list of capabilities

6.2.6.2.4 Type: ImsProfileData

Table 6.2.6.2.4-1: Definition of type ImsProfileData

Attribute name

Data type

P

Cardinality

Description

supportedFeatures

SupportedFeatures

O

0..1

See clause 6.2.8

imsServiceProfiles

array(ImsServiceProfile)

M

1..N

IMS service profile shared by several public identities when they belong to an IRS.

chargingInfo

ChargingInfo

O

0..1

A response body containing the Charging Information for the user.

serviceLevelTraceInfo

ServiceLevelTraceInformation

O

0..1

IMS Service Level Trace information. Syntax described in 3GPP TS 24.323 [24].

servicePriorityLevelList

array(NameSpacePriority)

O

1..N

List of namespaces and their associated priorities allowed for the user.

maxAllowedSimulReg

integer

O

0..1

Maximum number of allowed simultaneous registrations for the Public User Identity.

servicePriorityLevel

integer

O

0..1

Possible values:

0 (Highest priority)

1

2

3

4 (Lowest priority)

6.2.6.2.5 Type: SharedData

Table 6.2.6.2.5-1: SharedData

Attribute name

Data type

P

Cardinality

Description

sharedDataId

SharedDataId

M

1

Identifier of the shared data

sharedImsIfcData

Ifcs

O

0..1

Shared IFC Subscription Data

NOTE 1: The attribute sharedImsIfcData shall not contain sharedDataIds.

NOTE 2: When shared data clash with individual data, individual data shall take precedence.

6.2.6.2.6 Type: ImsDataSets

Table 6.2.6.2.6-1: ImsDataSets

Attribute name

Data type

P

Cardinality

Description

ifcData

IfcData

O

0..1

IFC Data

6.2.6.2.7 Type: RepositoryData

Table 6.2.6.2.7-1: Definition of type RepositoryData

Attribute name

Data type

P

Cardinality

Description

serviceData

string

M

1

The Repository Data for the requested Service Indication. Base64 encoded.

sequenceNumber

SequenceNumber

M

1

The sequence number associated to the current version of Repository Data.

6.2.6.2.8 Type: MsisdnList

Table 6.2.6.2.8-1: Definition of type MsisdnList

Attribute name

Data type

P

Cardinality

Description

basicMsisdn

Msisdn

M

1

The basic (or correlation) MSISDN associated to the IMS Public Identity for the IMS Private Identity indicated (if any)

additionalMsisdns

array(Msisdn)

O

1..N

Additional MSISDNs

6.2.6.2.9 Type: PublicIdentities

Table 6.2.6.2.9-1: Definition of type PublicIdentities

Attribute name

Data type

P

Cardinality

Description

publicIdentities

array(PublicIdentity)

M

1..N

List of IMS Public Identities associated

6.2.6.2.10 Type: PublicIdentity

Table 6.2.6.2.10-1: Definition of type PublicIdentity

Attribute name

Data type

P

Cardinality

Description

imsPublicId

ImsPublicId

M

1

IMS Public Identity (distinct or wildcarded)

identityType

IdentityType

M

1

Type of IMS Public Identity (e.g. Wildcarded Public Service Identity type)

irsIsDefault

boolean

O

0..1

Indicates whether the IMS Public Identity is the default within the Implicit Registration Set. Absence and false indicates "non-default".
Only one identity in SIP URI format and one identity in TEL URI format (if any) shall have value True for this attribute.

aliasGroupId

string

O

0..1

Indicates the Alias Public User Identity Group to which the Public User Identity belongs. Absence indicates that the identity does not belong to any Alias Group

6.2.6.2.11 Type: ImsSdmSubscription

Table 6.2.6.2.11-1: ImsSdmSubscription

Attribute name

Data type

P

Cardinality

Description

nfInstanceId

NfInstanceId

M

1

Identity of the NF Instance creating the subscription.

callbackReference

Uri

M

1

URI provided by the NF service consumer to receive notifications

monitoredResourceUris

array(Uri)

M

1..N

A set of URIs that identify the resources for which a change triggers a notification.

The URI shall take the form of either an absolute URI or an absolute-path reference as defined in IETF RFC 3986 [31].

See NOTE.

expires

DateTime

C

0..1

If present, indicates the point in time at which the subscription expires.
Within a POST request the proposed expiry time is conveyed whereas in a POST response or PATCH response the confirmed expiry time is returned.

NOTE: The HSS should handle only the relative-path part (apiSpecificResourceUriPart, see 3GPP TS 29.501 [5] clause 4.4.1) and ignore possible inconsistencies in the base URI part.

6.2.6.2.12 Type: ImsRegistrationStatus

Table 6.2.6.2.12-1: Definition of type ImsRegistrationStatus

Attribute name

Data type

P

Cardinality

Description

imsUserStatus

ImsRegistrationState

M

1

It contains the registration state of the user or the IRS, as described in 3GPP TS 29.328 [38], clause 7.6.3.

6.2.6.2.13 Type: PriorityLevels

Table 6.2.6.2.13-1: Definition of type PriorityLevels

Attribute name

Data type

P

Cardinality

Description

servicePriorityLevelList

array(NameSpacePriority)

M

1..N

List of namespaces and their associated priorities allowed for the user.

servicePriorityLevel

integer

O

0..1

Possible values:

0 (Highest priority)

1

2

3

4 (Lowest priority)

6.2.6.2.14 Type: Ifcs

Table 6.2.6.2.14-1: Definition of type Ifcs

Attribute name

Data type

P

Cardinality

Description

ifcList

array(Ifc)

C

1..N

List of complete IFCs which are associated to the user.

cscfFilterSetIdList

array(cscfFilterSetId)

C

1..N

List of S-CSCF specific filter set identifiers.

NOTE: At least one of IfcList or cscfFilterSetIdList shall be present.

6.2.6.2.15 Type: Ifc

Table 6.2.6.2.15-1: Definition of type Ifc

Attribute name

Data type

P

Cardinality

Description

priority

integer

M

1

Contains the priority of the IFC. The higher the Priority Number the lower the priority of the Filter Criteria is.

Minimum: 1

trigger

TriggerPoint

O

1

Contains the conditions that should be checked in order to find out if the indicated Application Server should be contacted or not. The absence of this attribute will indicate an unconditional triggering to Application Server.

appServer

ApplicationServer

M

1

Contains the Application Server which shall be triggered if the conditions are met and its associated data (e.g. default handling)

NOTE : See 3GPP TS 29.228 [20], Annex B.2.2 for more details on the terms and concepts associated to Initial Filter Criteria. The ProfilePartIndicator attribute described in Annex B.2.2 is removed and it shall be derived from the SessionCase attribute described in Annex B.2.3.

6.2.6.2.16 Type: TriggerPoint

Table 6.2.6.2.16-1: Definition of type TriggerPoint

Attribute name

Data type

P

Cardinality

Description

conditionType

TypeOfCondition

M

1

Indicates how the set of SPTs are expressed, i.e. either an Ored set of ANDed sets of SPT statements or an ANDed set of Ored sets of statements. These combinations are termed, respectively, Disjunctive Normal Form (DNF) and Conjunctive Normal Form (CNF) for the SPT (see 3GPP TS 29.228 [20], Annex C).

sptList

array(Spt)

M

1..N

Contains the list of Service Point Triggers

6.2.6.2.17 Type: Spt

Table 6.2.6.2.17-1: Definition of type Spt

Attribute name

Data type

P

Cardinality

Description

conditionNegated

boolean

M

1

Indicates if the Service Point Trigger instance is negated (i.e. NOT logical expression)

sptGroup

array(SptGroupId)

M

1..N

Contains the SPT group or list of SPT groups assigned to the SPT.

regType

array(RegistrationType)

O

1..2

Indicates the type of registration. If included, it shall contain the values that define whether the SPT matches to REGISTER messages that are related to initial registrations, re-registrations, and/or de-registrations. This attribute shall be included only if the SPT is for SIP method with a value "REGISTER" and only if it does not apply to all types of registration; otherwise, it shall be absent (i.e. the SIP Method SPT matches to all REGISTER messages).

The attribute regType shall be discarded if it is present in an SPT other than SIP Method with value "REGISTER".

requestURI

string

C

1

Contains the request-URI of the SIP request (NOTE 2)

sipMethod

string

C

1

Contains the method of the SIP request (NOTE 2)

sipHeader

HeaderSipRequest

C

1

Contains a header (and optionally value of the header) in the SIP request (NOTE 2)

sessionCase

RequestDirection

O

1

Contains the direction of the SIP request as evaluated by the S-CSCF.

sessionDescription

SdpDescription

C

1

Contains a SDP line (and optionally the valuein the line) within the body (if any) of a SIP request (NOTE 2)

NOTE 1: See 3GPP TS 29.228 [20], Annex B.2.3 for more details on the terms and concepts associated to Service Point Trigger. The ProfilePartIndicator attribute described in Annex B.2.2 is removed and it shall be derived from the SessionCase attribute described in Annex B.2.3.

NOTE 2: Exactly one of requestURI, method, header and sessionDescription shall be present. See TS 29.228 [20], Annex F for the definition of these attributes.

6.2.6.2.18 Type: HeaderSipRequest

Table 6.2.6.2.18-1: Definition of type HeaderSipRequest

Attribute name

Data type

P

Cardinality

Description

header

string

M

1

Contains a SIP header

content

string

O

1

Contains the content of the SIP header. If this attribute is absent, it shall indicate that the SPT is the presence (if conditionNegated="FALSE") or absence (if conditionNegated="TRUE") of the SIP header.

6.2.6.2.19 Type: SdpDescription

Table 6.2.6.2.19-1: Definition of type SdpDescription

Attribute name

Data type

P

Cardinality

Description

line

string

M

1

Contains a line in the session description

content

string

O

1

Contains the content of the SDP line. If this attribute is absent, it shall indicate that the SPT is the presence (if conditionNegated="FALSE") or absence (if conditionNegated="TRUE") of the SDP line.

6.2.6.2.20 Type: ApplicationServer

Table 6.2.6.2.20-1: Definition of type ApplicationServer

Attribute name

Data type

P

Cardinality

Description

asUri

string

M

1

Contains the Application Server SIP URI, as described in IETF RFC 3261 [22] or 3GPP TS 23.003 [13].

sessionContinue

boolean

O

1

This IE indicates whether the SIP dialog shall be continued or released if the Application Server could not be reached.

true: indicates that the session shall be continued

false or absent: indicates that the session shall be released

serviceInfoList

array(ServiceInformation)

O

1..N

Indicates a list of service information that shall be sent to the Application Server.

6.2.6.2.21 Type: ImsLocationData

Table 6.2.6.2.21-1: Definition of type ImsLocationData

Attribute name

Data type

P

Cardinality

Description

scscfName

string

M

1

S-CSCF name assigned to the IMS subscription the UE belongs to in the form of a SIP URI, as defined in IETF RFC 3261 [22].

6.2.6.2.22 Type: ServiceLevelTraceInformation

Table 6.2.6.2.22-1: Definition of type ServiceLevelTraceInformation

Attribute name

Data type

P

Cardinality

Description

serviceLevelTraceInfo

string

M

1

IMS Service Level Trace information. Syntax described in 3GPP TS 24.323 [24]

6.2.6.2.23 Type: PsLocation

Table 6.2.6.2.23-1: Definition of type PsLocation

Attribute name

Data type

P

Cardinality

Description

sgsnLocation

SgsnLocationData

O

0..1

Location information as retrieved from SGSN

mmeLocation

MmeLocationData

O

0..1

Location information as retrieved from MME

amfLocation

AmfLocationData

O

0..1

Location information as retrieved from AMF

twanLocation

TwanLocationData

O

0..1

3GPP AAA Server for TWAN Location information.

NOTE: At least one of the "sgsnLocation", "mmeLocation", "amfLocation" or "twanLocation" shall be included.

6.2.6.2.24 Type: SgsnLocationData

Table 6.2.6.2.24-1: Definition of type SgsnLocationData

Attribute name

Data type

P

Cardinality

Description

sgsnNumber

string

M

1

SGSN number. See 3GPP TS 23.003 [13] clause 5.1.

plmnId

PlmnId

M

1

PLMN identity

sgsnLocation

UtraLocation

O

0..1

User location as retrieved from SGSN.

csgInformation

CsgInformation

O

0..1

Closed Subscriber Group Information. See 3GPP TS 23.060 [25].

timeZone

TimeZone

O

0..1

Local Time Zone information (Time Zone and Daylight Saving Time) of the location in the visited network where the UE is located.

ratType

RatType

O

0..1

RAT type

6.2.6.2.25 Type: MmeLocationData

Table 6.2.6.2.25-1: Definition of type MmeLocationData

Attribute name

Data type

P

Cardinality

Description

mmeAddress

DiameterIdentity

M

1

MME diameter identity

plmnId

PlmnId

M

1

PLMN identity

mmeLocation

EutraLocation

O

0..1

User location as retrieved from MME.

csgInformation

CsgInformation

O

0..1

Closed Subscriber Group Information. See 3GPP TS 23.060 [25].

timeZone

TimeZone

O

0..1

Local Time Zone information (Time Zone and Daylight Saving Time) of the location in the visited network where the UE is located.

ratType

RatType

O

0..1

RAT type

6.2.6.2.26 Type: AmfLocationData

Table 6.2.6.2.26-1: Definition of type AmfLocationData

Attribute name

Data type

P

Cardinality

Description

amfAddress

NfInstanceId

M

1

AMF identity.

plmnId

PlmnId

M

1

PLMN identity

amfLocation

NrLocation

O

0..1

User location as retrieved from AMF.

smsfAddress

NfInstanceId

O

0..1

SMSF identity

timeZone

TimeZone

O

0..1

Local Time Zone information (Time Zone and Daylight Saving Time) of the location in the visited network where the UE is located.

ratType

RatType

O

0..1

RAT type

6.2.6.2.27 Type: TwanLocationData

Table 6.2.6.2.27-1: Definition of type TwanLocationData

Attribute name

Data type

P

Cardinality

Description

twanSsid

string

M

1

TWAN SSID, as defined in 3GPP TS 29.273 [26].

plmnId

PlmnId

M

1

PLMN identity of the TWAN

twanBssid

string

O

0..1

TWAN BSSID, as defined in 3GPP TS 29.273 [26].

civicAddress

string

O

0..1

Defined in clause 3.4 of IETF RFC 4776 [27] excluding the first 3 octets.

Base64 encoded, according to IETF RFC 2045 [28]).

twanOperatorName

string

O

0..1

TWAN Operator Name, as defined in clause 19.8 of 3GPP TS 23.003 [13].

timeZone

TimeZone

O

0..1

Local Time Zone information (Time Zone and Daylight Saving Time) of the location in the visited network where the UE is located.

logicalAccessId

string

O

0..1

Logical Access ID, as defined in ETSI ES 283 034 [29].

6.2.6.2.28 Type: CsLocation

Table 6.2.6.2.28-1: Definition of type CsLocation

Attribute name

Data type

P

Cardinality

Description

mscNumber

string

M

0..1

MSC number. See 3GPP TS 23.003 [13] clause 5.1.

vlrNumber

string

M

0..1

VLR number. See 3GPP TS 23.003 [13] clause 5.1.

plmnId

PlmnId

M

0..1

PLMN identity

vlrLocation

GeraLocation

O

0..1

User location as retrieved from MSC/VLR.

csgInformation

CsgInformation

O

0..1

Closed Subscriber Group Information. See 3GPP TS 23.060 [25].

timeZone

TimeZone

O

0..1

Local Time Zone information (Time Zone and Daylight Saving Time) of the location in the visited network where the UE is located.

eUtranCgi

Ecgi

O

0..1

E-UTRAN Cell Global Identity

tai

Tai

O

0..1

Tracking Area ID

6.2.6.2.29 Type: CsgInformation

Table 6.2.6.2.29-1: Definition of type CsgInformation

Attribute name

Data type

P

Cardinality

Description

csgId

string

M

1

CSG Identity. Syntax described in 3GPP TS 29.002 [30] i.e. 5 octets BER encoded value of 27-bit BIT STRING (Base64 encoded according to IETF RFC 2045 [28]).

Length = 8.

accessMode

string

O

0..1

CSG Access Mode. Syntax described in 3GPP TS 29.002 [30] (Base64 encoded according to IETF RFC 2045 [28]).

Length = 4.

cMi

boolean

O

0..1

CSG Membership Indication

0: CSG membership

1: non CSG membership

6.2.6.2.30 Type: SrvccData

Table 6.2.6.2.30-1: Definition of type SrvccData

Attribute name

Data type

P

Cardinality

Description

stnSr

StnSr

M

1

Iindicates the STN-SR (Session Transfer Number for SRVCC) of the UE.

ueSrvccCapabilities

array(SrvccCapability)

O

1..N

List of accesses supported by UE SRVCC capability (e.g. 4G, 5G).

Absence of this attribute indicates that UE is not SRVCC capable.

6.2.6.2.31 Type: PsiActivationState

Table 6.2.6.2.31-1: Definition of type PsiActivationState

Attribute name

Data type

P

Cardinality

Description

activationState

ActivationState

M

1

Indicates whether the PSI is active or inactive

6.2.6.2.32 Type: ImsServiceProfile

Table 6.2.6.2.32-1: Definition of type ImsServiceProfile

Attribute name

Data type

P

Cardinality

Description

publicIdentifierList

array(PublicIdentifier)

M

1..N

List of public identities sharing the same service profile and its individual data

ifcs

Ifcs

O

1

List of IFCs and/or shared IFC set identifiers

cnServiceAuthorization

CoreNetworkServiceAuthorization

O

0..1

Core Network Service Authorization

6.2.6.2.33 Type: PublicIdentifier

Table 6.2.6.2.33-1: Definition of type PublicIdentifier

Attribute name

Data type

P

Cardinality

Description

publicIdentity

PublicIdentity

M

1

Public identity information

displayName

string

O

1

Name associated with the public identity

imsServicePriority

PriorityLevels

O

1

Multimedia service priority

serviceLevelTraceInfo

ServiceLevelTraceInformation

O

1

Service Level Tracing Information

barringIndicator

boolean

O

1

Indicates whether the identity is barred, i.e. it can not be used in any IMS communication except registrations, re-registrations and de-registrations.

true: identitiy is barred

false or absent: identity is not barred

wildcardedImpu

String

O

1

When identityType is wildcarded IMPU it contains the wildcard id as stored by HSS

6.2.6.2.34 Type: ImeiSvInformation

Table 6.2.6.2.34-1: Definition of type ImeiSvInformation

Attribute name

Data type

P

Cardinality

Description

imei

Imei

C

1

Indicates the IMEI

imeiSv

ImeiSv

C

1

Indicates the IMEISV

NOTE: Either imei or imeiSv shall be present.

6.2.6.2.35 Void
6.2.6.2.36 Type: TadsInformation

Table 6.2.6.2.36-1: Definition of type TadsInformation

Attribute name

Data type

P

Cardinality

Description

voiceOverPsSessionSupport

ImsVoiceOverPsSessionSupport

M

1

Indicates the support for Voice over PS

accessType

AccessType

O

0..1

Indicates the type of access

ratType

RatType

O

0..1

Indicates the RAT Type

lastUeActivityTime

DateTime

O

0..1

Indicates the time of the last radio contact with the UE.

6.2.6.2.37 Type: UeReachabilitySubscription

Table 6.2.6.2.37-1: Definition of type UeReachabilitySubscription

Attribute name

Data type

P

Cardinality

Description

expiry

DateTime

M

1

Indicates the suggested time at which monitoring should cease and the subscription should become invalid.

callbackReference

Uri

M

1

Callback URI provided by the subscribing NF service consumer.

6.2.6.2.38 Type: UeReachabilityNotification

Table 6.2.6.2.38-1: Definition of type UeReachabilityNotification

Attribute name

Data type

P

Cardinality

Description

reachabilityIndicator

boolean

M

1

Indicates that the UE has been detected reachable for IP.

detectingNode

DetectingNode

M

1

Indicates the serving node which detected the UE reachability for IP.

accessType

AccessType

C

1

Indicates the access type (e.g. non 3GPP) where the reachability was detected. It shall be present when the serving node is AMF.

6.2.6.2.39 Type: PsUserState

Table 6.2.6.2.39-1: Definition of type PsUserState

Attribute name

Data type

P

Cardinality

Description

sgsnUserState

UserStatePs

C

0..1

User state as retrieved from SGSN

mmeUserState

UserStatePs

C

0..1

User state as retrieved from MME

amfUserState

UserStatePs

C

0..1

User state as retrieved from AMF

NOTE: At least one of the "sgsnUserState", "mmeUserState" or "amfUserState" shall be included.

6.2.6.2.40 Type: CsUserState

Table 6.2.6.2.40-1: Definition of type PsUserState

Attribute name

Data type

P

Cardinality

Description

mscVlrUserState

UserStateCs

M

1

User state as retrieved from MSC/VLR

6.2.6.2.41 Type: Csrn

Table 6.2.6.2.41-1: Definition of type CsrnInformation

Attribute name

Data type

P

Cardinality

Description

csrn

Msisdn

M

1

Contains a CS domain routeing number as retrieved from MSC/VLR

6.2.6.2.42 Type: ReferenceLocationInformation

Table 6.2.6.2.42-1: Definition of type ReferenceLocationInformation

Attribute name

Data type

P

Cardinality

Description

accessType

string

C

1

Indicates the type of access for which the reference location of the user is defined (e.g. ADSL).

accessInfo

string

C

1

Indicates the type of the access information defined for the reference location of the user (e.g. dsl-location).

accessValue

string

C

1

It contains the location information (e.g. line identifier in fixed access networks) as configured by the operator.

NOTE 1: At least one of accessType or accessInfo or accessValue shall be present.

NOTE 2: The syntax of accessType, accessInfo and accessValue is as described in 3GPP TS 24.229 [18] for P-Access-Network-Info header fields: accessType corresponds to the "access-type" field whereas accessInfo and accessValue correspond to the type and associated value defined for the "access-info" field.

6.2.6.2.43 Type: SmsRegistrationInfo

Table 6.2.6.2.43-1: Definition of type SmsRegistrationInfo

Attribute name

Data type

P

Cardinality

Description

ipSmGwNumber

Msisdn

M

1

IP-SM-GW number

scAddress

Msisdn

O

0..1

Short Message Service Centre Address

6.2.6.2.44 Type: IpSmGwAddress

Table 6.2.6.2.44-1: Definition of type IpSmGwAddress

Attribute name

Data type

P

Cardinality

Description

ipSmGwNumber

Msisdn

M

1

IP-SM-GW number

ipSmGwDiaUri

DiameterIdentity

O

0..1

IP-SM-GW Diameter Uri. It shall be present if s6c is supported.

ipSmGwDiaRealm

DiameterIdentity

O

0..1

IP-SM-GW Diameter Realm. It shall be present if s6c is supported.

ipSmGwSbiSupInd

boolean

C

0..1

SBI Support Indication of the IP-SM-GW. it shall be present if provided in SMS Registration Information Creation or Update procedure (see clauses 5.3.2.7.6)

Contains the indication on whether or not the IP-SM-GW is expecting to support SBI-based MT SM transmit.

– true: the IP-SM-GW supports SBI for MT SM transmit.

– false, or absence of this attribute: the IP-SM-GW do not support SBI for MT SM transmit.

6.2.6.2.45 Type: ImsAssociatedIdentities

Table 6.2.6.2.45-1: Definition of type ImsAssociatedIdentities

Attribute name

Data type

P

Cardinality

Description

irsState

ImsRegistrationState

M

1

It contains the registration state of the Implicit Registration Set.

publicIdentities

PublicIdentities

M

1

List of IMS Public Identities associated.

6.2.6.2.46 Type: DsaiTagInformation

Table 6.2.6.2.46-1: Definition of type DsaiTagInformation

Attribute name

Data type

P

Cardinality

Description

dsaiTagStatusList

array(DsaiTagStatus)

M

1..N

List of DSAI Tags associated to the Application Server Name.

6.2.6.2.47 Type: DsaiTagStatus

Table 6.2.6.2.47-1: Definition of type DsaiTagStatus

Attribute name

Data type

P

Cardinality

Description

dsaiTag

string

M

1

DSAI tag associated to the Application Server Name.

dsaiStatus

ActivationState

M

1

Status of DSAI tag

6.2.6.2.48 Type: CreatedUeReachabilitySubscription

Table 6.2.6.2.48-1: Definition of type CreatedUeReachabilitySubscription

Attribute name

Data type

P

Cardinality

Description

expiry

DateTime

M

1

Indicates the granted time at which monitoring will cease and the subscription becomes invalid.

6.2.6.2.49 Type: PrivateIdentities

Table 6.2.6.2.49-1: Definition of type PrivateIdentities

Attribute name

Data type

P

Cardinality

Description

privateIdentities

array(PrivateIdentity)

M

1..N

List of IMS Private Identities associated.

6.2.6.2.50 Type: PrivateIdentity

Table 6.2.6.2.50-1: Definition of type PrivateIdentity

Attribute name

Data type

P

Cardinality

Description

privateIdentity

PrivateId

M

1

IMS Private Identity.

privateIdentityType

PrivateIdentityType

M

1

Type of IMS Private Identity (e.g. IMPI or IMSI).

6.2.6.2.51 Type: ScscfSelectionAssistanceInformation

Table 6.2.6.2.51-1: Definition of type ScscfSelectionAssistanceInformation

Attribute name

Data type

P

Cardinality

Description

scscfCapabilityList

ScscfCapabilityList

C

0..1

Information about mandatory and optional S-CSCF capabilities.

Shall be present if scscfNames is absent; may be present otherwise.

scscfNames

array(string)

C

1..N

a list of S-CSCF names the UE can be steered to. Each strings shall contain a SIP-URL as defined in IETF RFC 3261 [22] to identify a SIP server (S-CSCF)

Shall be present if scscfCapabilityList is absent; may be present otherwise.

6.2.6.2.52 Type: ChargingInfo

Table 6.2.6.2.52-1: Definition of type ChargingInfo

Attribute name

Data type

P

Cardinality

Description

primaryEventChargingFunctionName

DiameterIdentity

C

0..1

See 3GPP TS 29.328

secondaryEventChargingFunctionName

DiameterIdentity

O

0..1

See 3GPP TS 29.328

primaryChargingCollectionFunctionName

DiameterIdentity

C

0..1

See 3GPP TS 29.328

secondaryChargingCollectionFunctionName

DiameterIdentity

O

0..1

See 3GPP TS 29.328

NOTE: At least primaryEventChargingFunctionName or primaryChargingCollectionFunctionName shall be present

6.2.6.2.53 Type: RepositoryDataList

Table 6.2.6.2.53-1: Definition of type RepositoryDataList

Attribute name

Data type

P

Cardinality

Description

repositoryDataMap

map(RepositoryData)

M

1..N

A map (list of key-value pairs where ServiceIndication serves as key) of RepositoryData.

6.2.6.2.54 Type: CoreNetworkServiceAuthorization

Table 6.2.6.2.54-1: Definition of type CoreNetworkServiceAuthorization

Attribute name

Data type

P

Cardinality

Description

subscribedMediaProfileId

integer

O

0..1

Subscribed Media Profile ID

6.2.6.3 Simple data types and enumerations

6.2.6.3.1 Introduction

This clause defines simple data types and enumerations that can be referenced from data structures defined in the previous clauses.

6.2.6.3.2 Simple data types

The simple data types defined in table 6.2.6.3.2-1 shall be supported.

Table 6.2.6.3.2-1: Simple data types

Type Name

Type Definition

Description

Capability

integer

S-CSCF capability

SequenceNumber

integer

Unsigned integer containing the sequence number associated to the current version of Repository Data

ServiceIndication

string

String containing the Service Indication or Service Identifier

Msisdn

string

String containing an additional or basic MSISDN

Pattern: "[0-9]{5,15}$"

PrivateId

string

String containing a Private User Identity or a Private Service Identity.

ImsPublicId

string

String containing an IMS Public Identity in SIP URI format or TEL URI format, as specified 3GPP TS 23.003 [13]

Pattern: "^(sip\:([a-zA-Z0-9_\-.!~*()&=+$,;?\/]+)\@([A-Za-z0-9]+([-A-Za-z0-9]+)\.)+[a-z]{2,}|tel\:\+[0-9]{5,15})$"

NameSpacePriority

string

String containing the namespace and priority. It shall be formatted as "r-value" parameter described in IETF RFC 4412 [19]. See also 3GPP TS 24.229 [18].

Pattern: "^[0-9a-zA-Z-\!%\*_\+`\’~]+.[0-9a-zA-Z-\!%\*_\+`\’~]+$"

CscfFilterSetId

integer

Contains the identifier of a specific filter set in the S-CSCF.

Minimum=0

SptGroupId

integer

Contains the identifier of the Group of SPTs.

Minimum=0

SharedDataId

string

Identifies globally and uniquely a piece of subscription data shared by multiple UEs. The value shall start with the HPLMN id (MCC/MNC) followed by a hyphen followed by a local Id as allocated by the home network operator.

Pattern: "[0-9]{5,6}-.+"

PrePaging

boolean

Inidicates the support of pre-paging.

SipServerName

string

Server Name (e.g. AS name, CSCF name) in SIP URI format

Pattern: "^(sip\:([a-zA-Z0-9_\-.!~*()&=+$,;?\/]+)\@([A-Za-z0-9]+([-A-Za-z0-9]+)\.)+[a-z]{2,})$"

6.2.6.3.3 Enumeration: DataSetName

The enumeration DataSetName represents a Set of Data within the IMS User Profile. It shall comply with the provisions defined in table 6.2.6.3.3-1.

Table 6.2.6.3.3-1: Enumeration DataSetName

Enumeration value

Description

"CHARGING_DATA"

Charging Information Data

"IFC_DATA"

Initial Filter Criteria Data

"TRACE_DATA"

IMS service level trace information

"PRIORITY_DATA"

Service Priority Levels

6.2.6.3.4 Enumeration: IdentityType

The enumeration IdentityType represents the type of IMS Public Identity. It shall comply with the provisions defined in table 6.2.6.3.4-1.

Table 6.2.6.3.4-1: Enumeration IdentityType

Enumeration value

Description

"DISTINCT_IMPU"

The identity is an IMS Public User Identity

"DISTINCT_PSI"

The identity is an IMS Public Service Identity

"WILDCARDED_IMPU"

The identity is an IMS Wildcarded Public User Identity

"WILDCARDED_PSI"

The identity is an IMS Wildcarded Public Service Identity

6.2.6.3.5 Enumeration: ImsRegistrationState

The enumeration ImsRegistrationState represents the IMS status of the user or Public Identity or the IRS. It shall comply with the provisions defined in table 6.2.6.3.5-1

Table 6.2.6.3.5-1: Enumeration ImsRegistrationState

Enumeration value

Description

"REGISTERED"

The identity is explicitly registered by the user.

"NOT_REGISTERED"

The identity is not registered.

"AUTHENTICATION_PENDING"

The identity initiated a registration and its authentication is ongoing (authentication pending flag is set).

"REGISTERED_UNREG_SERVICES"

The identity is not registered but has an S-CSCF assigned.

NOTE: See clause 3.1 for more details on the IMS registration states and terms.

6.2.6.3.6 Enumeration: TypeOfCondition

The enumeration TypeOfCondition represents the type of condition to be applied to the logical expression of SPT groups and SPTs. See 3GPP TS 29.228 [20], Annex C.

Table 6.2.6.3.6-1: Enumeration TypeOfCondition

Enumeration value

Description

Applicability

"CNF"

Conjunctive form

"DNF"

Disjunctive form

6.2.6.3.7 Enumeration: RegistrationType

The enumeration RegistrationType represents the type of registration associated to the REGISTER request.

Table 6.2.6.3.7-1: Enumeration RegistrationType

Enumeration value

Description

Applicability

"INITIAL_REGISTRATION"

The request is related to an initial registration

"RE_REGISTRATION"

The request is related to a re-registration

"DE_REGISTRATION"

The request is related to a de-registration

6.2.6.3.8 Enumeration: RequestDirection

The enumeration RequestDirection represents the direction of the request in combination with the registration status of the user as evaluated in the S-CSCF.

Table 6.2.6.3.8-1: Enumeration RequestDirection

Enumeration value

Description

Applicability

"ORIGINATING_REGISTERED"

The request is originated by an explicitly registered user.

"ORIGINATING_UNREGISTERED"

The request is originated by a non-registered user.

"ORIGINATING_CDIV "

The REGISTER request is related to an originating request after call diversion service (regardless of the registration state).

"TERMINATING_REGISTERED"

The request is targeted to an explicitly registered user.

"TERMINATING _UNREGISTERED"

The request is targeted to a non-registered user.

6.2.6.3.9 Enumeration: ServiceInformation

The enumeration ServiceInformation indicates the type of additional information to be included in the body of the SIP request towards the Application Server.

Table 6.2.6.3.9-1: Enumeration ServiceInformation

Enumeration value

Description

Applicability

"INCLUDE_REGISTER_REQUEST"

Indicates to the S-CSCF that the incoming SIP REGISTER request is to be transferred to the Application Server.

"INCLUDE_REGISTER_RESPONSE"

Indicates to the S-CSCF that the final SIP response to the incoming SIP REGISTER request is to be transferred to the Application Server.

NOTE: See 3GPP TS 23.218 [43] for the use of this information.

6.2.6.3.10 Enumeration: RequestedNode

The enumeration RequestedNode represents serving node requested. It shall comply with the provisions defined in table 6.2.6.3.10-1.

Table 6.2.6.3.10-1: Enumeration RequestedNode

Enumeration value

Description

Applicability

"SGSN"

The requested node is SGSN.

"MME"

The requested node is MME.

"AMF"

The requested node is AMF.

"3GPP_AAA_SERVER_TWAN"

The requested node is 3GPP-AAA-SERVER-TWAN

6.2.6.3.11 Enumeration: SrvccCapability

The enumeration SrvccCapability represents the type of UE support for SRVCC. It shall comply with the provisions defined in table 6.2.6.3.11-1.

Table 6.2.6.3.11-1: Enumeration IdentityType

Enumeration value

Description

"UE_4G_SRVCC_CAPABLE"

UE is 4G SRVCC capable

"UE_5G_SRVCC_CAPABLE"

UE is 5G SRVCC capable

6.2.6.3.12 Enumeration: ActivationState

The enumeration ActivationState represents the activation state of a PSI or DSAI tag. It shall comply with the provisions defined in table 6.2.6.3.12-1.

Table 6.2.6.3.12-1: Enumeration ActivationState

Enumeration value

Description

"ACTIVE"

"INACTIVE"

6.2.6.3.13 Enumeration: ImsVoiceOverPsSessionSupport

The enumeration ImsVoiceOverPsSessionSupport represents the support for Voice over PS associated to the UE.

Table 6.2.6.3.13-1: Enumeration ImsVoiceOverPsSessionSupport

Enumeration value

Description

Applicability

"IMS_VOICE_OVER_PS_NOT_SUPPORTED"

Voice over PS is supported for the UE

"IMS_VOICE_OVER_PS_SUPPORTED"

Voice over PS is not supported for the UE

"IMS_VOICE_OVER_PS_SUPPORT_UNKNOWN"

Voice over PS support for the UE is unknown

6.2.6.3.14 Enumeration: AccessType

The enumeration AccessType represents the type of access. It shall comply with the provisions defined in table 6.2.6.3.14-1.

Table 6.2.6.3.14-1: Enumeration AccessType

Enumeration value

Description

Applicability

"3GPP_ACCESS"

"NON_3GPP_ACCESS"

6.2.6.3.15 Enumeration: UserStatePs

The enumeration UserStatePs represents the user state in PS domain.

Table 6.2.6.3.15-1: Enumeration ImsVoiceOverPsSessionSupport

Enumeration value

Description

Applicability

"DETACHED"

"ATTACHED_NOT_REACHABLE_FOR_PAGING"

"ATTACHED_REACHABLE_FOR_PAGING"

"CONNECTED_NOT_REACHABLE_FOR_PAGING"

"CONNECTED_REACHABLE_FOR_PAGING"

"NOT_PROVIDED_FROM_SGSN_OR_MME_OR_AMF"

"NETWORK_DETERMINED_NOT_REACHABLE"

NOTE: See 3GPP TS 29.272 [32] for PS/EPS User State and 3GPP TS 29.518 [33] for the 5GS User State

6.2.6.3.16 Enumeration: UserStateCs

The enumeration UserStateCs represents the user state in CS domain.

Table 6.2.6.3.16-1: Enumeration ImsVoiceOverPsSessionSupport

Enumeration value

Description

Applicability

"CAMEL_BUSY"

"NETWORK_DETERMINED_NOT_REACHABLE"

"ASSUMED_IDLE"

"NOT_PROVIDED_FROM_VLR"

NOTE: See 3GPP TS 23.078 [31] for CS Subscriber State

6.2.6.3.17 Enumeration: PrivateIdentityType

The enumeration PrivateIdentityType represents the type of IMS Private Identity. It shall comply with the provisions defined in table 6.2.6.3.17-1.

Table 6.2.6.3.17-1: Enumeration PrivateIdentityType

Enumeration value

Description

"IMPI"

The identity is an IMS Private User Identity.

"IMSI"

The identity is an IMSI.