6.1.6 Data Model

29.5033GPP5G SystemRelease 18Stage 3TSUnified Data Management Services

6.1.6.1 General

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

Table 6.1.6.1-1 specifies the data types defined for the Nudm_SDM service API.

Table 6.1.6.1-1: Nudm_SDM specific Data Types

Data type

Clause defined

Description

Nssai

6.1.6.2.2

Network Slice Selection Assistance Information

SdmSubscription

6.1.6.2.3

A subscription to notifications

AccessAndMobilitySubscriptionData

6.1.6.2.4

Access and Mobility Subscription Data

SmfSelectionSubscriptionData

6.1.6.2.5

SMF Selection Subscription Data

DnnInfo

6.1.6.2.6

Data Network Name and associated information (LBO roaming allowed flag)

SnssaiInfo

6.1.6.2.7

S-NSSAI and associated information (DNN Info)

SessionManagementSubscriptionData

6.1.6.2.8

User subscribed session management data

DnnConfiguration

6.1.6.2.9

User subscribed data network configuration

PduSessionTypes

6.1.6.2.11

Default/allowed session types for a data network

SscModes

6.1.6.2.12

Default/allowed SSC modes for a data network

SmsSubscriptionData

6.1.6.2.13

SmsManagementSubscriptionData

6.1.6.2.14

SMS Management Subscription Data

SubscriptionDataSets

6.1.6.2.15

UeContextInSmfData

6.1.6.2.16

UE Context In SMF Data

PduSession

6.1.6.2.17

IdTranslationResult

6.1.6.2.18

SUPI that corresponds to a given GPSI

ModificationNotification

6.1.6.2.21

IpAddress

6.1.6.2.22

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

UeContextInSmsfData

6.1.6.2.23

SmsfInfo

6.1.6.2.24

AcknowledgeInfo

6.1.6.2.25

SorInfo

6.1.6.2.26

Steering Of Roaming Information

SharedData

6.1.6.2.27

Subscription Data shared by multiple UEs

PgwInfo

6.1.6.2.28

Information about the DNNs/APNs and PGW-C+SMF FQDNs used in interworking with EPS

TraceDataResponse

6.1.6.2.29

Contains Trace Data or a shared data Id identifying shared Trace Data

SteeringContainer

6.1.6.2.30

SdmSubsModification

6.1.6.2.31

Modification instruction for a subscription to notifications

EmergencyInfo

6.1.6.2.32

Information about emergency session

UpuInfo

6.1.6.2.33

UE Parameters Update Information

GroupIdentifiers

6.1.6.2.34

NiddInformation

6.1.6.2.35

Non-IP Data Delivery information

CagData

6.1.6.2.36

CagInfo

6.1.6.2.37

DataSetName

6.1.6.3.3

PduSessionContinuityInd

6.1.6.3.7

AdditionalSnssaiData

6.1.6.2.38

Additional information specific to a slice

VnGroupData

6.1.6.2.39

AppDescriptor

6.1.6.2.40

AppPortId

6.1.6.2.41

Application Port Id

LcsPrivacyData

6.1.6.2.42

Lpi

6.1.6.2.43

UnrelatedClass

6.1.6.2.44

PlmnOperatorClass

6.1.6.2.45

ValidTimePeriod

6.1.6.2.46

LcsMoData

6.1.6.2.47

EcRestrictionDataWb

6.1.6.2.48

Enhance Coverage Restriction Data

ExpectedUeBehaviourData

6.1.6.2.49

Expected UE Behaviour Data

SuggestedPacketNumDl

6.1.6.2.52

Suggested Number of Downlink Packets

FrameRouteInfo

6.1.6.2.54

Frame Route Information

SorUpdateInfo

6.1.6.2.55

EnhancedCoverageRestrictionData

6.1.6.2.56

Enhanced Coverage Restriction Data

EdrxParameters

6.1.6.2.57

eDRX Parameters

PtwParameters

6.1.6.2.58

Paging Time Window Parameters

OperationMode

6.1.6.3.12

Operation Mode

SorUpdateIndicator

6.1.6.3.13

SoR Update Indicator

ExternalUnrelatedClass

6.1.6.2.62

AfExternal

6.1.6.2.63

LcsClientExternal

6.1.6.2.64

LcsClientGroupExternal

6.1.6.2.65

ServiceTypeUnrelatedClass

6.1.6.2.66

UeId

6.1.6.2.67

DefaultUnrelatedClass

6.1.6.2.68

ContextInfo

6.1.6.2.69

Contains the HTTP Headers received by the NFs

UeContextInAmfData

6.1.6.2.70

V2xSubscriptionData

6.1.6.2.71

V2X Subscription Data

LcsBroadcastAssistanceTypesData

6.1.6.2.72

LCS Broadcast Assistance Data Types

DatasetNames

6.1.6.2.73

Data Set Names

PlmnRestriction

6.1.6.2.74

ProseSubscriptionData

6.1.6.2.76

ProSe Subscription Data

AerialUeSubscriptionInfo

6.1.6.2.78

Aerial UE Subscription Information

SmSubsData

6.1.6.2.79

ExtendedSmSubsData

6.1.6.2.80

AmfInfo

6.1.6.2.81

AMF information

ProSeAllowedPlmn

6.1.6.2.82

Contains the allowed PLMN information for ProSe Service

ImmediateReport

6.1.6.2.83

UDM SDM Immediate Report

MbsSubscriptionData

6.1.6.2.84

5MBS Subscription Data

UcSubscriptionData

6.1.6.2.85

User Consent Subscription Data

UeContextInSmfDataSubFilter

6.1.6.2.86

UE Context In Smf Data Subscription Filter

UeIdentifiers

6.1.6.2.87

List of UE identifiers

SupiInfo

6.1.6.2.88

List of the SUPIs

DefaultDnnIndicator

6.1.6.3.2

LboRoamingAllowed

6.1.6.3.2

UeUsageType

6.1.6.3.2

MpsPriorityIndicator

6.1.6.3.2

McsPriorityIndicator

6.1.6.3.2

3GppChargingCharacteristics

6.1.6.3.2

3GPP Charging Characteristics

MicoAllowed

6.1.6.3.2

SmsSubscribed

6.1.6.3.2

SharedDataId

6.1.6.3.2

IwkEpsInd

6.1.6.3.2

Interworking with EPS Indication

SecuredPacket

6.1.6.3.2

UpuRegInd

6.1.6.3.2

ExtGroupId

6.1.6.3.2

NbIoTUePriority

6.1.6.3.2

CodeWord

6.1.6.3.2

AfId

6.1.6.3.2

LcsClientId

6.1.6.3.2

DataSetName

6.1.6.3.3

PduSessionContinuityInd

6.1.6.3.7

LocationPrivacyInd

6.1.6.3.8

PrivacyCheckRelatedAction

6.1.6.3.9

LcsClientClass

6.1.6.3.10

LcsMoServiceClass

6.1.6.3.11

OperationMode

6.1.6.3.12

CodeWordInd

6.1.6.3.14

MdtUserConsent

6.1.6.3.15

MDT User Consent

SharedDataTreatmentInstruction

6.1.6.3.16

GpsiType

6.1.6.3.17

Type of GPSI (MSISDN or External-ID)

SorTransparentContainer

6.1.6.3.2

AerialUeIndication

6.1.6.3.18

Indication on whether Aerial service for UE is allowed or not.

UpuTransparentContainer

6.1.6.3.2

ProseDirectAllowed

6.1.6.3.19

Contains the ProSe Services that can be authorised by the given PLMN identity.

UcPurpose

6.1.6.3.20

Purpose of the user consent

UserConsent

6.1.6.3.21

User Consent

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

Table 6.1.6.1-2: Nudm_SDM re-used Data Types

Data type

Reference

Comments

Dnn

3GPP TS 29.571 [7]

Data Network Name with Network Identifier only; this type is used as key in a map of:

– DnnConfigurations; see clause 6.1.6.2.8;

– EpsIwkPgws; see clause 6.2.6.2.2;

– ExpectedUeBehaviourData; see clause 6.1.6.2.8;

DurationSec

3GPP TS 29.571 [7]

Time value in seconds

ProblemDetails

3GPP TS 29.571 [7]

Common data type used in response bodies

Snssai

3GPP TS 29.571 [7]

Single NSSAI

Uri

3GPP TS 29.571 [7]

Uniform Resource Identifier

Gpsi

3GPP TS 29.571 [7]

Generic Public Subscription Identifier

RatType

3GPP TS 29.571 [7]

Radio Access Technology Type

Area

3GPP TS 29.571 [7]

ServiceAreaRestriction

3GPP TS 29.571 [7]

CoreNetworkType

3GPP TS 29.571 [7]

SupportedFeatures

3GPP TS 29.571 [7]

see 3GPP TS 29.500 [4] clause 6.6

PlmnId

3GPP TS 29.571 [7]

PLMN Identity

PduSessionType

3GPP TS 29.571 [7]

SubscribedDefaultQos

3GPP TS 29.571 [7]

Subscribed Default QoS

Ambr

3GPP TS 29.571 [7]

AmbrRm

3GPP TS 29.571 [7]

SliceMbrRm

3GPP TS 29.571 [7]

PduSessionId

3GPP TS 29.571 [7]

PduSessionId is used as key in a map of PduSessions; see clause 6.1.6.2.16.

NfInstanceId

3GPP TS 29.571 [7]

Supi

3GPP TS 29.571 [7]

RfspIndexRm

3GPP TS 29.571 [7]

SscMode

3GPP TS 29.571 [7]

Ipv4Addr

3GPP TS 29.571 [7]

Ipv6Addr

3GPP TS 29.571 [7]

Ipv6Prefix

3GPP TS 29.571 [7]

SorMac

3GPP TS 29.509 [24]

SteeringInfo

3GPP TS 29.509 [24]

AckInd

3GPP TS 29.509 [24]

CounterSor

3GPP TS 29.509 [24]

UpuMac

3GPP TS 29.509 [24]

UpuData

3GPP TS 29.509 [24]

UpuAckInd

3GPP TS 29.509 [24]

CounterUpu

3GPP TS 29.509 [24]

TraceData

3GPP TS 29.571 [7]

Trace control and configuration parameters

NotifyItem

3GPP TS 29.571 [7]

UpSecurity

3GPP TS 29.571 [7]

ServiceName

3GPP TS 29.510 [19]

OdbPacketServices

3GPP TS 29.571 [7]

GroupId

3GPP TS 29.571 [7]

This type is also used as key of a map in attributes:

– vnGroupInfo and sharedVnGroupDataIds; see clause 6.1.6.2.4, 6.1.6.2.8, 6.1.6.2.27;

DateTime

3GPP TS 29.571 [7]

CagId

3GPP TS 29.571 [7]

StnSr

3GPP TS 29.571 [7]

Session Transfer Number for SRVCC

CMsisdn

3GPP TS 29.571 [7]

Correlation MSISDN

OsId

3GPP TS 29.519 [33]

Uint16

3GPP TS 29.571 [7]

RgWirelineCharacteristics

3GPP TS 29.571 [7]

GeographicArea

3GPP TS 29.572 [34]

LcsServiceType

3GPP TS 29.572 [34]

ScheduledCommunicationTime

3GPP TS 29.571 [7]

Scheduled Communication Time

LocationArea

6.5.6.2.10

StationaryIndication

3GPP TS 29.571 [7]

Stationary Indication

TrafficProfile

3GPP TS 29.571 [7]

Traffic Profile

ScheduledCommunicationType

3GPP TS 29.571 [7]

Scheduled Communication Type

BatteryIndication

3GPP TS 29.571 [7]

Battery Indication

AcsInfo

3GPP TS 29.571 [7]

ACS Information

IPv4AddrMask

3GPP TS 29.571 [7]

Fqdn

3GPP TS 29.571 [7]

Fully Qualified Domain Name

NefId

3GPP TS 29.510 [19]

PatchResult

3GPP TS 29.571 [7]

NrV2xAuth

3GPP TS 29.571 [7]

LteV2xAuth

3GPP TS 29.571 [7]

ProseServiceAuth

3GPP TS 29.571 [7]

BitRate

3GPP TS 29.571 [7]

MdtConfiguration

3GPP TS 29.571 [7]

Uint64

3GPP TS 29.571 [7]

WirelineArea

3GPP TS 29.571 [7]

WirelineServiceAreaRestriction

3GPP TS 29.571 [7]

NfGroupId

3GPP TS 29.571 [7]

EcsServerAddr

3GPP TS 29.571 [7]

RedirectResponse

3GPP TS 29.571 [7]

Response body of the redirect response message

Bytes

3GPP TS 29.571 [7]

Binary data encoded as a base64 character string

SpatialValidityCond

3GPP TS 29.571 [7]

AccessType

3GPP TS 29.571 [7]

Access Type

NsSrg

3GPP TS 29.571 [7]

NSSRG value

MbsSessionId

3GPP TS 29.571 [7]

5MBS Session Id

RoamingRestrictions

3GPP TS 29.571 [7]

Roaming Restrictions related information

PlmnIdNid

3GPP TS 29.571 [7]

6.1.6.2 Structured data types

6.1.6.2.1 Introduction

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

6.1.6.2.2 Type: Nssai

Table 6.1.6.2.2-1: Definition of type Nssai

Attribute name

Data type

P

Cardinality

Description

Applicability

supportedFeatures

SupportedFeatures

O

0..1

See clause 6.1.8

defaultSingleNssais

array(Snssai)

M

1..N

A list of Single Nssais used as default. (NOTE 1) (NOTE 2) (NOTE 3) (NOTE 4)

singleNssais

array(Snssai)

O

1..N

List of non default Single Nssais. (NOTE 1) (NOTE 3)

provisioningTime

DateTime

C

0..1

This attribute shall be present if the Nssai is sent to the AMF while reception has not yet been acknowledged from the UE; otherwise shall be absent.
This attribute serves as Network Slicing Subscription Change Indication.

additionalSnssaiData

map(AdditionalSnssaiData)

O

1..N

A map (list of key-value pairs where singleNssai converted to string serves as key) of additional information related to this single Nssai.

Nssaa, Nsac, Nssrg

suppressNssrgInd

boolean

O

0..1

Indicates whether the AMF shall provide all subscribed S-NSSAIs to the UE not indicating support of subscription-based restrictions to simultaneous registration of network slices, even if these S-NSSAIs do not share a common NSSRG.

true: indicates that the AMF shall provide all subscribed S-NSSAIs to the UE not indicating support of subscription-based restrictions to simultaneous registration of network slices.

false: indicates that the AMF does not need to provide all subscribed S-NSSAIs to the UE not indicating support of subscription-based restrictions to simultaneous registration of network slices.

Nssrg

NOTE 1: If the NF consumer does not support Nssaa optional feature, the UDM shall not include S-NSSAI(s) subject to Network Slice-Specific Authentication and Authorization in Get response messages, immediate reports within Subscribe response messages, or data change notifications where the data change is limited to S-NSSAI(s) subject to Network Slice-Specific Authentication and Authorization.
The total number of subscribed S-NSSAIs (including default S-NSSAIs and non-default S-NSSAIs) shall not exceed 16.

NOTE 2: If NSSRG information is present in the subscription data, the default S-NSSAIs, if more than one is present, are associated with the same NSSRG values as defined in clause 5.15.12 of 3GPP TS 23.501 [2].

NOTE 3: If NSSRG information is present, at least one NSSRG shall be associated with each of the S-NSSAIs in the subscription information.

NOTE 4: If the use case requires the UE to remain reachable at all times with at least one slice, it is recommended that at least one default S-NSSAI is not subject to network slice admission control, to avoid registration rejection in the case of no requested NSSAI was provided or none of the S-NSSAIs in the requested NSSAI was allowed (e.g. due to exceeding the maximum number of UEs configured for that S-NSSAI) as specified in clause 4.2.11.2 of 3GPP TS 23.502 [3].

6.1.6.2.3 Type: SdmSubscription

Table 6.1.6.2.3-1: Definition of type SdmSubscription

Attribute name

Data type

P

Cardinality

Description

Applicability

nfInstanceId

NfInstanceId

M

1

Identity of the NF Instance creating the subscription.

implicitUnsubscribe

boolean

O

0..1

If present with value true indicates that the subscription expires when the subscribing NF (AMF, SMF, SMSF) identified by the nfInstanceId ceases to be registered at the UDM.

When the subscribing NF is an SMF, this means that the subscription is terminated by UDM when the last PDU session of such SMF is deregistered for a given SUPI.

If the subscribing NF (AMF. SMF, SMSF) is not registered when the SDM subscription with implicitUnsubscribe indicator set to true is received by the UDM, the UDM should return a confirmed expiry time in the expires attribute to the subscribing NF even when the expires attribute is absent from the request.

See NOTE 1.

expires

DateTime

C

0..1

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

callbackReference

Uri

M

1

URI provided by the NF service consumer to receive notifications

amfServiceName

ServiceName

O

0..1

When present, this IE shall contain the name of the AMF service to which Data Change Notifications are to be sent (see clause 6.5.2.2 of 3GPP TS 29.500 [4]). This IE may be included if the NF service consumer is an AMF.

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 3.
Monitored Resource URIs should not contain query parameters. Instead, attributes within the SdmSubscription (e.g. singleNssai, dnn, plmnId) may be used for filtering. Received query parameters may be ignored by the UDM.

singleNssai

Snssai

O

0..1

This IE may be present if the consumer is SMF.

This attribute shall be also used as filter for the Nudr notifications when sdmSubscription is included in subscriptionDataSubscription in Nudr POST operation.

See NOTE 2.

dnn

Dnn

O

0..1

This IE may be present if the consumer is SMF.

This attribute shall be also used as filter for the Nudr notifications when sdmSubscription is included in subscriptionDataSubscription in Nudr POST operation.

When present, this IE shall contain the Network Identifier only, or Wildcard DNN.

See NOTE 2.

subscriptionId

string

C

0..1

This attribute shall be present if the SdmSubscription is sent in a GET response message on Nudr. It identifies the individual sdmSubscription stored in the UDR and may be used by the UDM to delete an expired or implicitly unsubscribed sdmSubscription.

plmnId

PlmnId

C

0..1

If present, it indicates the PLMN of the NF Instance creating the subscription (i.e., the PLMN serving the UE).

It shall be present if the NF Instance is located in a different PLMN than the UDM.

If absent, the Home PLMN ID is used as default.

immediateReport

boolean

O

0..1

This IE indicates whether immediate report is needed or not.

When present, this IE shall be set as following:

– true: immediate report is required

– false (default) immediate report is not required

ImmediateReport

report

ImmediateReport

C

0..1

This IE shall be present in Subscribe response, if the immediateReport attribute is set to "true" in Subscribe request.

When present, this IE shall contain the representation of subscription data sets that to be monitored, i.e. listed in monitoredResourceUris attribute.

ImmediateReport

supportedFeatures

SupportedFeatures

O

0..1

See clause 6.1.8
These are the features supported by the NF subscribing at the UDM.

contextInfo

ContextInfo

C

0..1

This IE if present may contain e.g. the headers received by the UDM along with the SdmSubscription.

Shall be absent on Nudm and may be present on Nudr.

nfChangeFilter

boolean

O

0..1

It may be present when monitoredResourceUris is related to the ue-context-in-amf-data and ue-context-in-smf-data.

If present, it indicates the consumer NF wants notification when NF is changed in the ue-context-in-amf-data and ue-context-in-smf-data.

ENA

uniqueSubscription

boolean

O

0..1

When present, this IE shall be set to indicate whether the subscription is a unique subscription, as specified in clause 5.2.2.3.2 and clause 5.2.2.3.3:

– true: the subscription is unique

– false: the subscription is not unique

LimitedSubscriptions

resetIds

array(string)

O

1..N

May be present in subscribe response messages.
The NF service consumer may decide to re-subscribe at the UDM when receiving a data restoration notification containing a matching resetId.

ueConSmfDataSubFilter

UeContextInSmfDataSubFilter

O

0..1

This IE may be present to receive the notification on changes for information in UeContextInSmfData related to specific PDU sessions.

UeConSmfDataSubFilter

adjacentPlmns

array(PlmnId)

O

1..N

PLMN identities of PLMNs adjacent to the PLMN serving the UE. If present the report in the subscribe response may contain adjacentPlmnRestrictions for the indicated PLMNs.
May be present when changes to AccessAndMobilitySubscriptionData are subscribed.

ImmediateReport

disasterRoamingInd

boolean

O

0..1

Disaster Roaming Indicator (see 3GPP TS 23.502 [3]).

When present, this IE shall be set as follows:

– true: Disaster Roaming service is applied;

– false (default): Disaster Roaming service is not applied.
May be present when changes to AccessAndMobilitySubscriptionData are subscribed.

ImmediateReport

NOTE 1: The subscription expires if the last registration identified by the nfInstanceId for the UE is deregistered at the UDM, e.g. the UDM shall remove the SdmSubscription of the SMF, if the UE’s last PDU session SMF registration of this SMF is deregistered.

NOTE 2: If "singleNssai" is not included, and "dnn" is not included, the UDM shall notify the data change of all DNN configurations and network slice(s).

If "singleNssai" is included, and "dnn" is not included, the UDM shall notify the data change of network slice identified by "singleNssai" and all DNN configurations for the requested network slice identified by "singleNssai".

If "singleNssai" is not included, and "dnn" is included, the UDM shall notify the data change of all network slices where such DNN is available and all DNN configurations identified by "dnn".

If "singleNssai" is included, and "dnn" is included, the UDM shall notify the data change of network slice identified by "singleNssai" where such DNN is available and the DNN configuration identified by "dnn", if such DNN is available in the network slice identified by "singleNssai".

NOTE 3: The UDM 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.1.6.2.4 Type: AccessAndMobilitySubscriptionData

Table 6.1.6.2.4-1: Definition of type AccessAndMobilitySubscriptionData

Attribute name

Data type

P

Cardinality

Description

Applicability

supportedFeatures

SupportedFeatures

O

0..1

See clause 6.1.8

gpsis

array(Gpsi)

O

0..N

List of Generic Public Subscription Identifier; see 3GPP TS 29.571 [7]

internalGroupIds

array(GroupId)

O

1..N

List of internal group identifier; see 3GPP TS 23.501 [2] clause 5.9.7

sharedVnGroupDataIds

map(SharedDataId)

O

1..N

A map of identifiers of shared 5G VN group data (list of key-value pairs whereGroupId serves as key; see clause 6.1.6.1).

This attribute is only applicable to the Nudm interface and shall not be included over the Nudr interface.

hssGroupId

NfGroupId

O

0..1

Identity of the HSS group associated with the subscription, which may be used by the UDM in discovering the HSS; see 3GPP TS 29.510 [19].

This attribute may be included if the coreNetworkTypeRestrictions does not indicate a value of "EPC".

This attribute is only applicable to the Nudr interface and shall not be included over the Nudm interface.

subscribedUeAmbr

AmbrRm

O

0..1

nssai

Nssai

O

0..1

Network Slice Selection Assistance Information

ratRestrictions

array(RatType)

O

0..N

List of RAT Types that are restricted in 5GC and EPC; see 3GPP TS 29.571 [7] (NOTE 2)

Contains unique items

forbiddenAreas

array(Area)

O

0..N

List of forbidden areas in 5GS (NOTE 6, NOTE 7)

serviceAreaRestriction

ServiceAreaRestriction

O

0..1

Subscribed Service Area Restriction (NOTE 7)

coreNetworkTypeRestrictions

array(CoreNetworkType)

O

0..N

List of Core Network Types that are restricted.

The use of the value "5GC" is deprecated on Nudm and shall be discarded by the receiving AMF.

accessTypeRestrictions

array(AccessType)

O

0..2

List of Access Types that are restricted.

If non-3GPP access is restricted, then the UDM shall reject/deregister the AMF non-3GPP registration.

If 3GPP access is restricted, then the UDM shall reject/deregister the AMF 3GPP registration.

Otherwise, the UDM shall pass the IE to the AMF.

rfspIndex

RfspIndexRm

O

0..1

Index to RAT/Frequency Selection Priority;

subsRegTimer

DurationSecRm

O

0..1

Subscribed periodic registration timer; (see clause 5.20 of 3GPP TS 23.501 [2], clause 4.15.3.2.3b and 4.15.6.3a of 3GPP TS 23.502 [3] and 3GPP TS 29.571 [7])

ueUsageType

UeUsageType

O

0..1

mpsPriority

MpsPriorityIndicator

O

0..1

mcsPriority

McsPriorityIndicator

O

0..1

activeTime

DurationSecRm

O

0..1

subscribed active time for PSM UEs (see clause 5.20 of 3GPP TS 23.501 [2] and clause 4.15.3.2.3b and 4.15.6.3a of 3GPP TS 23.502 [3]).

sorInfo

SorInfo

O

0..1

On Nudm, this IE shall be present if the UDM shall send the information for Steering of Roaming during registration or the subscription data update to the UE. The UDM may detect the need to send sorInfo by retrieving context information from the UDR.

(NOTE 4)

sorInfoExpectInd

Boolean

C

0..1

Contains the indication on whether or not the UE is expecting to receive SoR information at initial registration.

– When set to true; it indicates that the UE is expecting to receive SoR information at initial registration in a VPLMN, i.e. the UDM shall send SoR information to the AMF on Nudm even when nothing was received from UDR or SOR-AF. In case the UDM was not able to obtain SoR information, SoR information sent on Nudm shall contain the indication that "no change" is needed.

– When set to false: it indicates that the UE is not expecting to receive SoR information at initial registration, i.e. the UDM shall send SoR information to the AMF based on operator policy.

This attribute may be present on Nudr interface and shall be absent on UDM interface.

The UDM shall ignore this attribute if the UE is not roaming out of its HPLMN.

sorafRetrieval

boolean

C

0..1

Contains the indication on whether or not SoR information shall be retrieved from the SOR-AF.

– When set to true: it indicates that the UDM shall retrieve SoR information from the SOR-AF.

– When set to false or absent: it indicates that the retrieval of SorInfo from the SOR-AF is not required.

This attribute may be present on Nudr interface and shall be absent on Nudm interface.

The UDM shall ignore this attribute if it is received in Nudr but the UE is not roaming out of its HPLMN.

sorUpdateIndicatorList

array(SorUpdateIndicator)

C

1..N

When present, it contains the list of SoR Update Indicators;

– It shall indicate that the AMF shall retrieve SoR information when the UE performs Registration with NAS Registration Type "Initial Registration" if the value "INITIAL_REGISTRATION" is included;

– And/or it shall indicate that the AMF shall retrieve SoR information when the UE performs Registration with NAS Registration Type "Emergency Registration" if the value "EMERGENCY_REGISTRATION" is included.

When absent on Nudm interface, it indicates that the AMF is not requested to retrieve SoR information when the UE performs Registration with either NAS Registration Type "Initial Registration" or NAS Registration Type "Emergency Registration".

The UDM shall ignore this attribute if the UE is not roaming out of its HPLMN.

upuInfo

UpuInfo

O

0..1

This IE shall be present if the UDM shall send the information for UE Parameters Update after the UE has been successfully authenticated and registered to the 5G system.

routingIndicator

string

O

0..1

This IE may be sent in Nudm_SDM notification as defined in 3GPP TS 23.502 Clause 4.20.2, if UE Parameter Update was sent for Routing Indicator Update, but without requesting the UE to re-register.

micoAllowed

MicoAllowed

O

0..1

Indicates whether the UE subscription allows MICO mode.

sharedAmDataIds

array(SharedDataId)

O

0..N

Identifier of shared Access And Mobility Subscription data

SharedData

odbPacketServices

OdbPacketServices

O

0..1

Operator Determined Barring for Packet Oriented Services (NOTE 3).

subscribedDnnList

array(Dnn)

O

0..N

List of the subscribed DNNs for the UE (including optionally the Wildcard DNN). Used to determine the list of LADN available to the UE as defined in clause 5.6.5 of TS 23.501 [2].

When present, this IE shall contain the Network Identifier only.

serviceGapTime

DurationSec

O

0..1

Used to set the Service Gap timer for Service Gap Control (see TS 23.501 [2] clause 5.26.16 and TS 23.502 [3] clause 4.2.2.2.2).

mdtUserConsent

MdtUserConsent

O

0..1

When present, this IE shall indicate whether the user has given his consent for MDT activation or not (see clause 4.9 of 3GPP TS 32.422 [48]).

When absent, "CONSENT_NOT_GIVEN" is the default value.

mdtConfiguration

MdtConfiguration

C

0..1

This IE shall be present if the MDT task is activated.

When present, this IE shall contain MDT configuration data for UE (see clause 4.1.2.17 of 3GPP TS 32.422 [48]).

traceData

TraceData

O

0..1

Trace requirements about the UE, only sent to AMF in the HPLMN or one of its equivalent PLMN(s)

cagData

CagData

O

0..1

Closed Access Group Data.

Shall be absent if both
– no CAG is subscribed for the serving PLMN and
– an acknowledgement from the UE is not pending.

CAGFeature

stnSr

StnSr

O

0..1

This IE shall be present if the UE is subscribed to 5G SRVCC.

When present, it indicates the STN-SR (Session Transfer Number for SRVCC) of the UE.

cMsisdn

CMsisdn

O

0..1

This IE shall be present if the UE is subscribed to 5G SRVCC.

When present, it indicates the C-MSISDN (Correlation MSISDN) of the UE.

nbIoTUePriority

NbIoTUePriority

O

0..1

Indicates NB IoT UE priority which is used by the NG-RAN to prioritise resource allocation between UEs accessing via NB-IoT(see clause 5.31.17 of 3GPP TS 23.501 [2]).

nssaiInclusionAllowed

boolean

O

0..1

Indicates that the UE is allowed to include NSSAI in the RRC connection establishment in clear text for 3GPP access, as specified in clause 5.15.9 of 3GPP TS 23.501 [2] and clause 4.2.2.2.2 of 3GPP TS 23.502 [3].

true: indicates that NSSAI can be included in RRC connection establishment by the UE.

false or absent: indicates that NSSAI cannot be included.

rgWirelineCharacteristics

RgWirelineCharacteristics

O

0..1

Indicates the RG Level Wireline Access Characteristics as specified in 3GPP TS 23.316 [37].

ecRestrictionDataWb

EcRestrictionDataWb

O

0..1

Indicates Enhanced Coverage Restriction Data for WB-N1 mode.

If absent, indicates Enhanced Coverage is not restricted for WB-N1 mode.

ecRestrictionDataNb

boolean

O

0..1

If present, this IE shall indicate whether Enhanced Coverage for NB-N1 mode is restricted or not.

true: Enhanced Coverage for NB-N1 mode is restricted.

false or absent: Enhanced Coverage for NB-N1 mode is allowed.

expectedUeBehaviourList

ExpectedUeBehaviourData

O

0..1

Indicates Expected UE Behaviour parameters associated with AMF(see clause 5.20 of 3GPP TS 23.501 [2] and clause  4.15.6.3 of 3GPP TS 23.502 [3]).

This attribute is only applicable to the Nudm interface and shall not be included over the Nudr interface.

primaryRatRestrictions

array(RatType)

O

0..N

List of RAT Types that are restricted for use as primary RAT in 5GC and EPC; see 3GPP TS 29.571 [7] (NOTE 2)

Contains unique items

secondaryRatRestrictions

array(RatType)

O

0..N

List of RAT Types that are restricted for use as secondary RAT in 5GC and EPC; see 3GPP TS 29.571 [7] (NOTE 2)

Contains unique items

edrxParametersList

array(EdrxParameters)

O

1..N

List of subscribed the extended idle mode DRX parameters (see clause 5.31.7.2.1 of 3GPP TS 23.501 [2]).

ptwParametersList

array(PtwParameters)

O

1..N

List of subscribed the Paging Time Window parameters (see clause 5.31.7.2.1 of 3GPP TS 23.501 [2]).

iabOperationAllowed

boolean

O

0..1

Indicates that the UE is allowed for IAB operation as specified in 3GPP TS 23.501 [2].

true: indicates that the UE is allowed for IAB operation.

false or absent: indicates that the UE is not allowed for IAB operation.

adjacentPlmnRestrictions

map(PlmnRestriction)

O

1..N

A map (list of key-value pairs where PlmnId converted to string serves as key; see 3GPP TS 29.571 [7]) of PlmnRestrictions for adjacent PLMNs

wirelineForbiddenAreas

array(WirelineArea)

O

0..N

List of forbidden areas for 5G-BRG/5G-CRG/FN-CRG (NOTE 6, NOTE 7)

wirelineServiceAreaRestriction

WirelineServiceAreaRestriction

O

0..1

Subscribed Service Area Restriction for 5G-BRG/5G-CRG/FN-CRG (NOTE 7)

pcfSelectionAssistanceInfos

array(PcfSelectionAssistanceInfo)

C

1..N

List of combination of DNN and S-NSSAI that indicates that the same PCF needs to be selected by the AMF. (NOTE 5)

aerialUeSubInfo

AerialUeSubscriptionInfo

O

0..1

This IE shall contain the subscribed Aerial UE Subscription Information when present.

roamingRestrictions

RoamingRestrictions

O

0..1

This IE is used by Nudr_DataRepository API starting with 3GPP Rel-17 and onwards (see Table 5.2.3.3.1-3 in 3GPP TS 29.505 [10]). If present, this IE contains information on the roaming restrictions. If this IE is absent e.g. if the UDR is not provisioned with the serving PLMN ID, then the UDM may use the UE’s home subscribed profile as the default profile to handle the roaming and SNPN scenarios.

remoteProvInd

boolean

O

0..1

Indicates whether the UE is allowed only for Remote Provisioning as specified in clause 5.30.2.10.3.2 of 3GPP TS 23.501 [2]. UE subscription either allows, or does not allow the UE to access the PLMN as the Onboarding Network using PLMN credentials.

– false (default), or the attribute is absent: indicates that the UE is not restricted to the Onboarding only;

– true: indicates that the UE is allowed only for the Onboarding.

NOTE 1: AccessAndMobilitySubscriptionData can be UE-individual data or shared data.
UE-individual data take precedence over shared data unless treatment instructions associated to the shared data indicate otherwise.
E.g.: When an attribute of type array is present but empty within UE-Individual data and present (with any cardinality) in shared data and no treatment instructions are applicable, the empty array takes precedence. Similarly, when a nullable attribute is present with value null within the individual data and present (with any value) in shared data and no treatment instructions are applicable, the null value takes precedence (i.e. for the concerned UE the attribute is considered absent).

NOTE 2: If the primaryRatRestrictions and secondaryRatRestrictions attributes are supported by the sender, the sender shall include the list of RAT Types that are restricted, if any, in the ratRestrictions attribute, shall include the list of RAT Types that are restricted for use as primary RAT, if any, in the primaryRatRestrictions attribute and shall include the list of RAT Types that are restricted for use as secondary RAT, if any, in the secondaryRatRestrictions attribute. If the primaryRatRestrictions and secondaryRatRestrictions attributes are supported by the receiver, the receiver shall use the data in the primaryRatRestrictions attribute, if received, as the list of RAT Types that are restricted for use as primary RAT, and shall use the data in the secondaryRatRestrictions attribute, if received, as the list of RAT Types that are restricted for use as secondary RAT, otherwise the receiver shall use the data in the ratRestrictions attribute, if received, as the list of RAT Types that are restricted.
If the secondaryRatRestictions attribute is included in the subscription profile, the content may be sent to MME during inter RAT handover from NR SA to EN-DC, for the purpose of adequate SGW selection at MME based on subscription profile, and to avoid allocating unnecessary resources for secondary RAT at EPC if it is restricted.

NOTE 3: The AMF shall take responsibility to perform PDU session related actions subject to change of OdbPacketService, e.g. release existing PDU session.

NOTE 4: The UDM shall ignore the content of sorInfo received on Nudr if "sorafRetrieval" is set to true.

NOTE 5: If multiple PDU sessions to one DNN and S-NSSAI are established in EPS, the AMF shall select the same PCF by configuration or by using existing method, e.g. same PCF selection in usage monitoring.

NOTE 6: When UE is only permitted in a small area, i.e. the UE is forbidden in most of TAIs in the PLMN, AreaCode (e.g. "All TAIs except xxx") may be used to avoid provisoning and transferring large number of TAIs. AeraCode may be used otherwise.

NOTE 7: AreaCode for VPLMN(s) may be provisioned under agreement between operators.

6.1.6.2.5 Type: SmfSelectionSubscriptionData

Table 6.1.6.2.5-1: Definition of type SmfSelectionSubscriptionData

Attribute name

Data type

P

Cardinality

Description

Applicability

supportedFeatures

SupportedFeatures

O

0..1

See clause 6.1.8

subscribedSnssaiInfos

map(SnssaiInfo)

O

0..N

List of S-NSSAIs and associated information (DNN Info); see 3GPP TS 23.501 [2] clause 6.3.2.
A map (list of key-value pairs where singleNssai converted to string serves as key; see 3GPP TS 29.571 [7]) of arrays of DnnInfo

sharedSnssaiInfosId

SharedDataId

O

0..1

Identifier of shared SnssaiInfos.

SharedData

hssGroupId

NfGroupId

O

0..1

Identity of the HSS group associated with the subscription, which may be used by the UDM in discovering the HSS; see 3GPP TS 29.510 [19].

May be present on the Nudr interface if there is DNN interworking with EPC and shall not be included over the Nudm interface.

NOTE: A single UE-individual subscribedSnssaiInfo (within subscribedSnssaiInfos) may clash with a sharedSnssaiInfo (i.e. both have the same singleNssai value as key). In this case the UE-individual subscribedSnssaiInfo takes precedence unless treatment instructions associated to the shared data indicate otherwise.

6.1.6.2.6 Type: DnnInfo

Table 6.1.6.2.6-1: Definition of type DnnInfo

Attribute name

Data type

P

Cardinality

Description

dnn

Dnn

M

1

Data Network Name with Network Identifier only., or Wildcard DNN (NOTE)

defaultDnnIndicator

DefaultDnnIndicator

O

0..1

Indicates whether this DNN is the default DNN:
true: The DNN is the default DNN (NOTE);
false: The DNN is not the default DNN;
If this attribute is absent it means the DNN is not the default DNN.

lboRoamingAllowed

LboRoamingAllowed

O

0..1

Indicates whether local breakout for the DNN is allowed when roaming:
true: Allowed;
false: Not allowed;
If this attribute is absent it means not allowed.

iwkEpsInd

IwkEpsInd

O

0..1

Indicates whether interworking with EPS is subscribed:

true: Subscribed;
false: Not subscribed;
If this attribute is absent it means not subscribed.

dnnBarred

boolean

C

0..1

Indicates whether the DNN is barred. Absence and false indicates "not barred".
This attribute is only used on the Nudr interface. The UDM shall handle barred DNNs received from the UDR as not subscribed.

invokeNefInd

boolean

O

0..1

Indicates whether the NEF based infrequent small data transfer shall be used for the PDU Session associated with the S-NSSAI and DNN.

true: Used;
false: Not used;
If this attribute is absent it means not used.

smfList

array(NfInstanceId)

O

1..N

Indicate the associated SMF(s) if the static IP address/prefix is used.

sameSmfInd

boolean

O

0..1

Indicates whether the same SMF for multiple PDU sessions to the same DNN and S-NSSAI is required.

true: Required;
false: Not required;
If this attribute is absent it means not required.

NOTE: If the dnn attribute contains the value of the Wildcard DNN ("*"), the defaultDnnIndicator shall not be set to true.

6.1.6.2.7 Type: SnssaiInfo

Table 6.1.6.2.7-1: Definition of type SnssaiInfo

Attribute name

Data type

P

Cardinality

Description

dnnInfos

array(DnnInfo)

M

1..N

list of Data Network Names for an S-NSSAI and associated information

6.1.6.2.8 Type: SessionManagementSubscriptionData

Table 6.1.6.2.8-1: Definition of type SessionManagementSubscriptionData

Attribute name

Data type

P

Cardinality

Description

Applicability

singleNssai

Snssai

M

1

A single Network Slice Selection Assistance Information

dnnConfigurations

map(DnnConfiguration)

O

0..N

Additional DNN configurations for the network slice;
A map (list of key-value pairs where DNN, or optionally the Wildcard DNN, serves as key; see clause 6.1.6.1) of DnnConfigurations.

(NOTE 1)

internalGroupIds

array(GroupId)

O

1..N

List of internal group identifier; see 3GPP TS 23.501 [2] clause 5.9.7

sharedVnGroupDataIds

map(SharedDataId)

O

1..N

A map of identifiers of shared 5G VN group data (list of key-value pairs where GroupId serves as key; see clause 6.1.6.1).

This attribute is only applicable to the Nudm interface and shall not be included over the Nudr interface.

traceData

TraceData

O

0..1

Trace requirements about the UE, only sent to SMF in the HPLMN or one of its equivalent PLMN(s)

sharedDnnConfigurationsId

SharedDataId

O

0..1

Identifier of shared data for DNN configuration.

SharedData

sharedTraceDataId

SharedDataId

O

0..1

Identifier of shared data for trace requirements

odbPacketServices

OdbPacketServices

O

0..1

Operator Determined Barring for Packet Oriented Services (NOTE 2).

expectedUeBehavioursList

map(ExpectedUeBehaviourData)

O

1..N

A map of ExpectedUeBehaviourDatas associated with SMF (DNN serves as key; see clause 6.1.6.1), see clause 5.20 of 3GPP TS 23.501 [2] and clause  4.15.6.3 of 3GPP TS 23.502 [3].

This attribute is only applicable to the Nudm interface and shall not be included over the Nudr interface.

suggestedPacketNumDlList

map(SuggestedPacketNumDl)

O

1..N

A map (list of key-value pairs where dnn serves as key; see clause 6.1.6.1) of SuggestedPacketNumDls which are associated with SMF (see clause 5.20 of 3GPP TS 23.501 [2] and clause  4.15.6.3 of 3GPP TS 23.502 [3]).

This attribute is only applicable to the Nudm interface and shall not be included over the Nudr interface.

3gppChargingCharacteristics

3GppChargingCharacteristics

O

0..1

Subscribed charging characteristics data associated to the subscription.

supportedFeatures

SupportedFeatures

O

0..1

See clause 6.1.8

NOTE 1: A given UE-individual dnnConfiguration (within dnnConfigurations) may clash with a shared dnnConfiguration (i.e. both have the same dnn value as key). In this case the clashing attributes of the UE-individual dnnConfiguration take precedence unless treatment instructions indicate otherwise.

NOTE 2: The SMF shall not trigger PDU session release when receiving change of OdbPacketService. Only the AMF take responsibility to perform PDU session related actions subject to change of ODB setting, e.g. release existing PDU session.

6.1.6.2.9 Type: DnnConfiguration

Table 6.1.6.2.9-1: Definition of type DnnConfiguration

Attribute name

Data type

P

Cardinality

Description

pduSessionTypes

PduSessionTypes

M

1

Default/Allowed session types

sscModes

SscModes

M

1

Default/Allowed SSC modes

iwkEpsInd

IwkEpsInd

O

0..1

Indicates whether interworking with EPS is subscribed:

true: Subscribed;
false: Not subscribed;
If this attribute is absent it means not subscribed.

5gQosProfile

SubscribedDefaultQos

O

0..1

5G QoS parameters associated to the session for a data network

sessionAmbr

Ambr

O

0..1

The maximum aggregated uplink and downlink bit rates to be shared across all Non-GBR QoS Flows in each PDU Session.

3gppChargingCharacteristics

3GppChargingCharacteristics

O

0..1

Subscribed charging characteristics data associated to the session for a data network. (NOTE 1)

staticIpAddress

array(IpAddress)

O

1..2

Subscribed static IP address(es) of the IPv4 and/or IPv6 type.

upSecurity

UpSecurity

O

0..1

When present, this IE shall indicate the security policy for integrity protection and encryption for the user plane.

pduSessionContinuityInd

PduSessionContinuityInd

O

0..1

When present, this IE shall indicate how to handle a PDU Session when UE the moves to or from NB-IoT.

If this attribute is absent it means that Local policy shall be used.

niddNefId

NefId

C

0..1

Indicates the identity of the NEF to be selected for NIDD service for this DNN. It is required if invokeNefSelection attribute is present with value "true".

niddInfo

NiddInformation

O

0..1

When present, this IE shall indicate information used for SMF-NEF Connection.

This attribute may be present if "Invoke NEF Selection" indicator is set.

redundantSessionAllowed

boolean

O

0..1

Indicates whether redundant PDU Sessions are allowed:

true: Allowed;
false: Not allowed;
If this attribute is absent it means not allowed.

acsInfo

AcsInfo

O

0..1

When present, this IE shall include the ACS information for the 5G-RG as defined in BBF TR-069 [42] or in BBF TR-369 [43].

ipv4FrameRouteList

array(FrameRouteInfo)

O

1..N

List of Frame Route information of IPv4, see clause 5.6.14 of 3GPP TS 23.501 [2].

ipv6FrameRouteList

array(FrameRouteInfo)

O

1..N

List of Frame Route information of IPv6, see clause 5.6.14 of 3GPP TS 23.501 [2].

atsssAllowed

boolean

O

0..1

Indicates whether this DNN supports ATSSS, i.e. whether Multi-Access PDU session is allowed to this DNN.

true: Allowed;
false (default): Not allowed;
If this attribute is absent it means this DNN does not allow ATSSS.

secondaryAuth

boolean

O

0..1

Indicates whether DN-AAA based secondary authentication and authorization is needed.

true: required.

false: not required.

If absent, it indicates that DN-AAA based secondary authentication is not required by subscription data, but it still may be required by local policies at the SMF.

(NOTE 2)

uavSecondaryAuth

boolean

O

0..1

Indicates whether SBI-based secondary authentication and authorization for Uncrewed Aerial Vehicles (UAV) is needed.

true: required.

false or absent: not required.

dnAaaIpAddressAllocation

boolean

O

0..1

Indicates whether the SMF is required to request the UE IP address from the DN-AAA server for PDU Session Establishment.

true: required

false: not required

If absent, it indicates that the request by SMF of the UE IP address from the DN-AAA server is not required by subscription data, but it still may be required by local policies at the SMF.

(NOTE 2)

dnAaaAddress

IpAddress

O

0..1

The IP address of the DN-AAA server used for secondary authentication and authorization.

(NOTE 2)

additionalDnAaaAddresses

array(IpAddress)

O

1..N

Additional IP addresses of the DN-AAA server used for secondary authentication and authorization.

(NOTE 2)

dnAaaFqdn

Fqdn

O

0..1

The FQDN of the DN-AAA server used for secondary authentication and authorization.

(NOTE 2)

iptvAccCtrlInfo

string

O

0..1

The IPTV access control information used in IPTV access procedure, see clause 7.7.1.1.2 of 3GPP TS 23.316 [37].

ipv4Index

IpIndex

O

0..1

Indicates the "IP Index" (i.e. information that identifies an address pool or an external server) to be sent to the SMF for allocation of an IPv4 address to the UE, for this DNN configuration.

ipv6Index

IpIndex

O

0..1

Indicates the "IP Index" (i.e. information that identifies an address pool or an external server) to be sent to the SMF for allocation of an IPv6 address to the UE, for this DNN configuration.

ecsAddrConfigInfo

EcsAddrConfigInfo

O

0..1

ECS Address Configuration Information Parameters. See 3GPP TS 23.502 [3]

additionalEcsAddrConfigInfos

array(EcsAddrConfigInfo)

O

1..N

This IE may be present when ecsAddrConfigInfo IE is present.

When present, this IE shall contain the additional ECS Address Configuration Information Parameters. See 3GPP TS 23.548 [60]

sharedEcsAddrConfigInfoId

SharedDataId

O

0..1

Identifier of shared data indicating an ECS Configuration Information.

additionalSharedEcsAddrConfigInfoIds

array(SharedDataId)

O

1..N

This IE may be present when sharedEcsAddrConfigInfoId IE is present.

When present, this IE shall contain the identifiers of shared data indicating the additional ECS Address Configuration Information.

easDiscoveryAuthorized

boolean

O

0..1

Indicates whether the UE is authorized to use 5GC assisted EAS discovery via EASDF.

true: Authorized;
false (default): Not authorized;
See 3GPP TS 23.548 [60]

onboardingInd

boolean

O

0..1

Indicates whether the UE is allowed to use this DNN for onboarding. UE subscription allows, or does not allow the UE to access the PLMN as the Onboarding Network using PLMN credentials (see clause 5.30.2.10.4.4 in 3GPP TS 23.501 [2]).

– false (default): not restricted to onboarding only;

– true: allowed for onboarding only.

aerialUeInd

AerialUeIndication

O

0..1

This IE shall indicate Aerial service for the UE is allowed or not allowed.

subscribedMaxIpv6PrefixSize

integer

O

0..1

maximum size of the IPv6 prefix that may be allocated for the PDU Session. See 3GPP TS 23.316 [37] clause 4.6.2.3.

NOTE 1: When present, this attribute shall take precedence over the "3gppChargingCharacteristics" attribute in the SessionManagementSubscriptionData level.

NOTE 2: These attributes shall be consistent with the information received on the 5GVnGroupData (see clause 6.5.6.2.7), in the Nudm_PP API. If both FQDN and IP addresses are provided, the IP addresses should be preferred to target the DN-AAA server.

6.1.6.2.10 Void
6.1.6.2.11 Type: PduSessionTypes

Table 6.1.6.2.11-1: Definition of type PduSessionTypes

Attribute name

Data type

P

Cardinality

Description

defaultSessionType

PduSessionType

C

0..1

Default session type, shall be present unless the VnGroupData is supported.

allowedSessionTypes

array(PduSessionType)

O

1..N

Additional session types allowed for the data network

6.1.6.2.12 Type: SscModes

Table 6.1.6.2.12-1: Definition of type SscModes

Attribute name

Data type

P

Cardinality

Description

defaultSscMode

SscMode

M

1

Default SSC mode

allowedSscModes

array(SscMode)

O

1..2

Additional SSC modes allowed for the data network

6.1.6.2.13 Type: SmsSubscriptionData

Table 6.1.6.2.13-1: Definition of type SmsSubscriptionData

Attribute name

Data type

P

Cardinality

Description

smsSubscribed

SmsSubscribed

C

0..1

Indicates whether the UE subscription allows SMS delivery over NAS. Shall not be absent unless the feature SharedData is supported and smsSubscribed is present within shared data.

sharedSmsSubsDataId

SharedDataId

C

0..1

Identifier of shared data. Shall be present if smsSubscribed is absent.

supportedFeatures

SupportedFeatures

O

0..1

See clause 6.1.8

6.1.6.2.14 Type: SmsManagementSubscriptionData

Table 6.1.6.2.14-1: Definition of type SmsManagementSubscriptionData

Attribute name

Data type

P

Cardinality

Description

Applicability

supportedFeatures

SupportedFeatures

O

0..1

See clause 6.1.8

mtSmsSubscribed

boolean

C

0..1

Indicates the SMS teleservice subscription for MT-SMS. Shall not be absent unless the feature SharedData is supported and mtSmsSubscribed is present within shared data.

mtSmsBarringAll

boolean

C

0..1

Barring of all MT-SMS

mtSmsBarringRoaming

boolean

C

0..1

Barring of MT-SMS when roaming outside the Home Public Land Mobile Network (PLMN) country

moSmsSubscribed

boolean

C

0..1

Indicates the SMS teleservice subscription for MO-SMS. Shall not be absent unless the feature SharedData is supported and moSmsSubscribed is present within shared data.

moSmsBarringAll

boolean

C

0..1

Barring of all MO-SMS

moSmsBarringRoaming

boolean

C

0..1

Barring of MO-SMS when roaming outside the Home Public Land Mobile Network (PLMN) country

traceData

TraceData

O

0..1

Trace requirements about the UE, only sent to SMSF in HPLMN

sharedSmsMngDataIds

array(SharedDataId)

C

1..N

Identifier of shared data. Shall be present if mtSmsSubscribed and/or moSmsSubscribed and/or traceData are absent.

SharedData

6.1.6.2.15 Type: SubscriptionDataSets

Table 6.1.6.2.15-1: Definition of type SubcriptionDataSets

Attribute name

Data type

P

Cardinality

Description

amData

AccessAndMobilitySubscriptionData

O

0..1

Access and Mobility Subscription Data

smfSelData

SmfSelectionSubscriptionData

O

0..1

SMF Selection Subscription Data

uecAmfData

UeContextInAmfData

O

0..1

UE Context In AMF Data

uecSmfData

UeContextInSmfData

O

0..1

UE Context In SMF Data

uecSmsfData

UeContextInSmsfData

O

0..1

UE Context In SMSF Data

smsSubsData

SmsSubscriptionData

O

0..1

SMS Subscription Data

smData

SmSubsData

O

0..1

Session Management Subscription Data

traceData

TraceData

O

0..1

Trace Data. The Null value indicates that trace is not active.

smsMngData

SmsManagementSubscriptionData

O

0..1

SMS Management Subscription Data

lcsPrivacyData

LcsPrivacyData

O

0..1

LCS Privacy Subscription Data

lcsMoData

LcsMoData

O

0..1

LCS Mobile Originated Subscription Data

v2xData

V2xSubscriptionData

O

0..1

V2x Subscription Data

lcsBroadcastAssistanceTypesData

LcsBroadcastAssistanceTypesData

O

0..1

LCS List of Broadcast Assistance Data Types Subscription Data

proseData

ProseSubscriptionData

O

0..1

ProSe Service Subscription Data

mbsData

MbsSubscriptionData

O

0..1

5MBS Subscription Data

ucData

UcSubscriptionData

O

0..1

User Consent Subscription Data

6.1.6.2.16 Type: UeContextInSmfData

Table 6.1.6.2.16-1: Definition of type UeContextInSmfData

Attribute name

Data type

P

Cardinality

Description

pduSessions

map(PduSession)

O

0..N

A map (list of key-value pairs where pduSessionId converted from integer to string serves as key; see clause 6.1.6.1) of PduSessions.

pgwInfo

array(PgwInfo)

O

1..N

Information about the DNNs/APNs and PGW-C+SMF FQDNs used in interworking with EPS

emergencyInfo

EmergencyInfo

O

0..1

Information about emergency session

NOTE: If sdmSubscription contains nfChangeFilter flag, then the UDM shall suppress the change notification for the pgwInfo and emergencyInfo:

6.1.6.2.17 Type: PduSession

Table 6.1.6.2.17-1: Definition of type PduSession

Attribute name

Data type

P

Cardinality

Description

dnn

Dnn

M

1

Data Network Name with Network Identifier only.

smfInstanceId

NfInstanceId

M

1

NF Instance Id of the SMF

plmnId

PlmnId

M

1

PLMN Id of the SMF

singleNssai

Snssai

O

0..1

A single Network Slice Selection Assistance Information.

(NOTE)

NOTE: For supporting selection of the same SMF if a UE requests multiple PDU sessions associated with the same DNN and same S-NSSAI, the S-NSSAI associated to the PDU session is required to be included.

6.1.6.2.18 Type: IdTranslationResult

Table 6.1.6.2.18-1: Definition of type IdTranslationResult

Attribute name

Data type

P

Cardinality

Description

supportedFeatures

SupportedFeatures

O

0..1

See clause 6.1.8

supi

Supi

M

1

SUPI

gpsi

Gpsi

C

0..1

If ueId is a SUPI in Resource URI variables, this shall be present and indicates an MSISDN or external identifier.

additionalSupis

array(Supi)

O

1..N

May be present when ueId is a GPSI in resource URI variables and more than one SUPIs matching the retrieval request have been received from the UDR.

additionalGpsis

array(Gpsi)

O

1..N

May be present when ueId is a SUPI in Resource URI variables and more than one GPSIs matching the retrieval request have been received from the UDR.

NOTE: When the UDM receives an array of more than one SUPIs from the UDR, the supi attribute shall convey the first received array element and the additionalSupis attribute shall convey subsequent received array elements.
When the UDM receives an array of more than one GPSIs from the UDR, the gpsi attribute shall convey the first received array element and the additionalGpsis attribute shall convey subsequent received array elements.

6.1.6.2.19 Void
6.1.6.2.20 Void
6.1.6.2.21 Type: ModificationNotification

Table 6.1.6.2.21-1: Definition of type ModificationNotification

Attribute name

Data type

P

Cardinality

Description

notifyItems

array(NotifyItem)

M

1..N

subscriptionId

string

C

0..1

A UDM complying with this release of the specification shall include the Subscription ID that was allocated by the UDM when the subscribe request was received. It may be used by the consumer of the UDM to correlate the received notification with the active subscription.

When the NF Service Consumer creates multiple subscriptions, it should use distinct callback URIs for each subscription.

6.1.6.2.22 Type: IpAddress

Table 6.1.6.2.22-1: Definition of type IpAddress

Attribute name

Data type

P

Cardinality

Description

ipv4Addr

Ipv4Addr

C

0..1

ipv6Addr

Ipv6Addr

C

0..1

ipv6Prefix

Ipv6Prefix

C

0..1

NOTE: Either ipv4Addr, or ipv6Addr, or ipv6Prefix shall be present.

6.1.6.2.23 Type: UeContextInSmsfData

Table 6.1.6.2.23-1: Definition of type UeContextInSmsfData

Attribute name

Data type

P

Cardinality

Description

smsfInfo3GppAccess

SmsfInfo

O

0..1

SMSF Info for 3GPP Access

smsfInfoNon3GppAccess

SmsfInfo

O

0..1

SMSF Info for Non 3GPP Access

6.1.6.2.24 Type: SmsfInfo

Table 6.1.6.2.24-1: Definition of type SmsfInfo

Attribute name

Data type

P

Cardinality

Description

smsfInstanceId

NfInstanceId

M

1

NF Instance Id of the SMSF

plmnId

PlmnId

M

1

PLMN Id of the SMSF

smsfSetId

NfSetId

C

0..1

NF Set Id of SMSF Set the registered SMSF instance belongs to; it shall be present if provided in SMSF registration procedure (see clauses 5.3.2.2.5 and 5.3.2.2.6)

6.1.6.2.25 Type: AcknowledgeInfo

Table 6.1.6.2.25: Definition of type AcknowledgeInfo

Attribute name

Data type

P

Cardinality

Description

Applicability

sorMacIue

SorMac

C

0..1

Shall be present when the Acknowledgement is sent to acknowledge receipt of SorInfo. Shall be absent when sorTransparentContainer is present.

upuMacIue

UpuMac

C

0..1

Shall be present when the Acknowledgement is sent to acknowledge receipt of UpuInfo. Shall be absent when upuTransparentContainer is present.

provisioningTime

DateTime

M

1

the provisioning time is used to correlate the acknowledgement with the modification request, to address glare cases when multiple modifications are ongoing simultaneously.

sorTransparentContainer

SorTransparentContainer

C

0..1

This attribute contains SoR transparent container as received from UE, encoded as defined in clause 6.1.6.3.2 and shall be present when sent to acknowledge receipt of SorInfo, if the UDM supports receiving SoR Transparent Container.

sorTransparentSupport

ueNotReachable

boolean

O

0..1

Transmission of SorInfo / UE Parameter Update data to the UE was not successful due to the UE not being reachable.
default: false
may be present if sorMacIue and upuMacIue and sorTransparentContainer are absent.

upuTransparentContainer

UpuTransparentContainer

C

0..1

This attribute contains UE Parameter Update transparent container as received from UE, encoded as defined in clause 6.1.6.3.2 and shall be present when sent to acknowledge receipt of UpuInfo, if the UDM supports receiving UE Parameter Update Transparent Container.

upuTransparentSupport

6.1.6.2.26 Type: SorInfo

Table 6.1.6.2.26: Definition of type SorInfo

Attribute name

Data type

P

Cardinality

Description

Applicability

ackInd

AckInd

M

1

Contains the indication on whether an acknowledgement from UE is to be requested to the UE.

If sorTransparentContainer is present, the AMF should ignore the value of ackInd on Nudm.

sorMacIausf

SorMac

C

0..1

Contains the SoR-MAC-IAUSF. Shall be present when SorInfo is sent within AccessAndMobilitySubscriptionData on Nudm, and shall be absent when sent on Nudr or within PpData. Shall be absent when sorTransparentContainer is present.

countersor

CounterSor

C

0..1

Contains the CounterSoR. Shall be present when SorInfo is sent within AccessAndMobilitySubscription on Nudm, and shall be absent when sent on Nudr or within PpData.

Shall be absent when sorTransparentContainer is present.

steeringContainer

SteeringContainer

C

0..1

When present, this information contains the information needed to update the "Operator Controlled PLMN Selector with Access Technology" list stored in the USIM either as an array of preferred PLMN/AccessTechnologies combinations in priority order (with the first entry in the array indicating the highest priority and the last entry indicating the lowest) or a secured packet.

If no change of the "Operator Controlled PLMN Selector with Access Technology" list stored in the USIM is needed, then this attribute shall be absent.

This attribute shall be present when SorInfo is sent within PpData.

Shall be absent when sorTransparentContainer is present.

provisioningTime

DateTime

M

1

Point in time of SorInfo provisioning at the UDR or SOR-AF.

sorTransparentContainer

SorTransparentContainer

C

0..1

This attribute contains protected SoR transparent container encoded as defined in clause 6.1.6.3.2 and shall be present when sent on Nudm, if NF Consumer (e.g. AMF) supports receiving SoR information encoded as transparent containers. Shall be absent when sent on Nudr or within PpData.

sorTransparentSupport

sorCmci

SorCmci

O

0..1

When present, provides the SOR-CMCI values as defined in 3GPP TS 24.501 [27]

This attribute may be present on Nudr, Nsoraf, PpData. Shall be absent on Nudm (since the content on Nudm is provided within sorTransparentContainer)

storeSorCmciInMe

Boolean

O

0..1

When present, indicates "Store the SOR-CMCI in the ME", i.e. whether to instruct UE to store SOR-CMCI in the ME as defined in 3GPP TS 23.122 [14] and 3GPP TS 24.501 [27].

– True: Indicates to store the SOR-CMCI in the ME

– False or absent: Indicates storing the SOR-CMCI in the ME is not required

This attribute may be present on Nudr, Nsoraf, PpData. Shall be absent on Nudm (since the content on Nudm is provided within sorTransparentContainer)

usimSupportOfSorCmci

Boolean

O

0..1

When present, indicates "USIM support of SOR-CMCI" based on pre-configuration.

  • True: Indicates that USIM supports SOR-CMCI
  • False or absent: Indicates that USIM does not support SOR-CMCI

This attribute may be present on Nudr. Shall be absent on Nudm (since the content on Nudm is provided within sorTransparentContainer)

6.1.6.2.27 Type: SharedData

Table 6.1.6.2.27-1: Definition of type SharedData

Attribute name

Data type

P

Cardinality

Description

Applicability

sharedDataId

SharedDataId

M

1

Identifier of the shared data

sharedAmData

AccessAndMobilitySubscriptionData

O

0..1

Shared Access and Mobility Subscription Data

sharedAmData shall not contain upuInfo, sorInfo, stnSr or cMsisdn.

sharedSmsSubsData

SmsSubscriptionData

O

0..1

Shared SMS Subscription Data

sharedSmsMngSubsData

SmsManagementSubscriptionData

O

0..1

Shared SMS Management Subscription Data

sharedDnnConfigurations

map(DnnConfiguration)

O

1..N

A map of shared DNN configuration (list of key-value pairs where DNN, or optionally the Wildcard DNN, serves as key)

sharedTraceData

TraceData

O

0..1

Shared Trace Data

sharedSnssaiInfos

map(SnssaiInfo)

O

1..N

A map of Shared Snssai Info (list of key-value pairs where singleNssai converted to string serves as key; see 3GPP TS 29.571 [7])

sharedVnGroupDatas

map(VnGroupData)

O

1..N

A map of shared 5G VN group data (list of key-value pairs where GroupId serves as key; see clause 6.1.6.1).

treatmentInstructions

map(SharedDataTreatmentInstruction)

O

1..N

A map of SharedDataTreatmentInstructions (list of key-value pairs where a JSON pointer pointing to an attribute within the SharedData serves as key)

SharedDataTreatment

sharedSmSubsData

SessionManagementSubscriptionData

O

0..1

Shared Session Management Subscription Data

SharedSmSubsData

sharedEcsAddrConfigInfo

EcsAddrConfigInfo

O

0..1

Shared ECS Address Configuration Information

NOTE 1: Exactly one of sharedAmData, sharedSmsSubsData, sharedSmsMngSubsData sharedDnnConfigurations, sharedTraceData and sharedSnssaiInfos shall be present.

NOTE 2: The attributes sharedAmData, sharedSmsSubsData and SharedSmsMngSubsData shall not contain sharedDataIds

NOTE 3: When shared data clash with individual data, individual data shall take precedence as default treatment unless the feature SharedDataTreatment is supported and the SharedData contains treatment instructions different from the default treatment.

6.1.6.2.28 Type: PgwInfo

Table 6.1.6.2.28-1: Definition of type PgwInfo

Attribute name

Data type

P

Cardinality

Description

dnn

Dnn

M

1

DNN/APN with Network Identifier only.

pgwFqdn

Fqdn

M

1

FQDN of the PGW in the "PGW-C+SMF" (NOTE)

pgwIpAddr

IpAddress

O

0..1

IP Address of the PGW in the "PGW-C+SMF"

plmnId

PlmnId

O

0..1

PLMN where the PGW-C+SMF is located

epdgInd

boolean

O

0..1

If present, it indicates whether access is from ePDG or not.

true: access is from ePDG.

false or absent: access is not from ePDG

pcfId

NfInstanceId

C

0..1

This IE shall be present if the PCF Selection Assistance Info is received from the UDM.

When present, it indicates the PCF identifier serving the PDU Session/PDN Connection that should be selected by the AMF.

registrationTime

DateTime

O

0..1

Time of PGW-C+SMF Registration (i.e. point in time when the HSS received SWx-SAR with SA_TYPE=REGISTRATION). May be present when used on Nhss within UeContextInPgwData.

NOTE: This IE may contain an empty string when the PGW Information is mapped from HSS and PGW FQDN is not registered in HSS.

6.1.6.2.29 Type: TraceDataResponse

Table 6.1.6.2.29-1: Definition of type TraceDataResponse

Attribute name

Data type

P

Cardinality

Description

Applicability

traceData

TraceData

C

0..1

UE-individual trace data. Shall not be absent unless the feature SharedData is supported and traceData is present within shared data.

sharedTraceDataId

SharedDataId

C

0..1

Shared data identifier. Shall be present if traceData is absent.

6.1.6.2.30 Type: SteeringContainer

Table 6.1.6.2.30-1: Definition of type SteeringContainer as a list of mutually exclusive alternatives

Data type

Cardinality

Description

array(SteeringInfo)

1..N

List of PLMN/AccessTechnologies combinations.

SecuredPacket

1

A Secured packet containing one or more APDUs commands dedicated to Remote File Management or command responses (see ETSI TS 102.225 [28]).

6.1.6.2.31 Type: SdmSubsModification

Table 6.1.6.2.31-1: Definition of type SdmSubsModification

Attribute name

Data type

P

Cardinality

Description

expires

DateTime

O

0..1

If present, indicates the point in time at which the subscription expires. Within a PATCH request the proposed new expiry time is conveyed.

monitoredResourceUris

array(Uri)

O

1..N

If present, indicates the updated resources URIs to be monitored.

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.

NOTE: The UDM 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.1.6.2.32 Type: EmergencyInfo

Table 6.1.6.2.32-1: Definition of type EmergencyInfo

Attribute name

Data type

P

Cardinality

Description

pgwFqdn

Fqdn

C

0..1

FQDN of the PGW-C+SMF for emergency session; either pgwFqdn or ipAddress shall be present. (NOTE)

pgwIpAddress

IpAddress

C

0..1

IP address of the PGW-C+SMF for emergency session (NOTE)

smfInstanceId

NfInstanceId

O

0..1

NF Instance Id of the SMF for emergency session (NOTE)

epdgInd

boolean

O

0..1

If present, it indicates whether access is from ePDG or not.

true: access is from ePDG.

false or absent: access is not from ePDG.

plmnId

PlmnId

O

0..1

PLMN where the PGW-C+SMF is located

NOTE: If the AMF fails to contact the SMF/PGW based on the provided information (pgwFqdn/pgwIpAddress/smfInstanceId) when needed, the AMF should use a locally configured SMF instance ID or SMF set ID for the SMF/PGW for emergency services.

6.1.6.2.33 Type: UpuInfo

Table 6.1.6.2.33-1: Definition of type UpuInfo

Attribute name

Data type

P

Cardinality

Description

Applicability

upuDataList

array(UpuData)

C

1..N

This information defines the UE Parameters Update (UPU).

A secured packet with the Routing indicator update data is included and/or the Default configured NSSAI update data are included on Nudm.

An unsecured Routing indicator update data or secured packet with the Routing indicator update data, and/or the Default configured NSSAI update data, and/or Disaster Roaming Enabled Indication, and/or the indication of ‘applicability of "lists of PLMN(s) to be used in disaster condition" provided by a VPLMN’ are included on Nudr.

Shall be absent when the NF Consumer (e.g. AMF) supports receiving UE Parameters Update information encoded as transparent containers, and the upuTransparentContainer attribute is present.

upuRegInd

UpuRegInd

C

0..1

Contains the indication of whether the re-registration is requested.

Shall be absent when the NF Consumer (e.g. AMF) supports receiving UE Parameters Update information encoded as transparent containers, and the upuTransparentContainer attribute is present.

upuAckInd

UpuAckInd

C

0..1

Contains the indication of whether the acknowledgement from UE is needed.

Shall be absent when the NF Consumer (e.g. AMF) supports receiving UE Parameters Update information encoded as transparent containers, and the upuTransparentContainer attribute is present.

upuMacIausf

UpuMac

C

0..1

Contains the UPU-MAC-IAUSF. Shall be present when UpuInfo is sent within AccessAndMobilitySubscriptionData on Nudm, and shall be absent when sent on Nudr.

Shall be absent when the NF Consumer (e.g. AMF) supports receiving UE Parameters Update information encoded as transparent containers, and the upuTransparentContainer attribute is present.

counterUpu

CounterUpu

C

0..1

Contains the CounterUPU. Shall be present when UpuInfo is sent within AccessAndMobilitySubscriptionData on Nudm, and shall be absent when sent on Nudr.

Shall be absent when the NF Consumer (e.g. AMF) supports receiving UE Parameters Update information encoded as transparent containers, and the upuTransparentContainer attribute is present.

provisioningTime

DateTime

M

1

Point in time of provisioning of UPU by the UDR.

upuTransparentContainer

UpuTransparentContainer

C

0..1

This attribute contains protected UE Parameters Update transparent container encoded as defined in clause 6.1.6.3.2 and shall be present when sent on Nudm, if NF Consumer (e.g. AMF) supports receiving UE Parameters Update information encoded as transparent containers. Shall be absent when sent on Nudr or within PpData.

upuTransparentSupport

6.1.6.2.34 Type: GroupIdentifiers

Table 6.1.6.2.34-1: Definition of type GroupIdentifiers

Attribute name

Data type

P

Cardinality

Description

extGroupId

ExtGroupId

C

0..1

This IE shall contain the External Group ID associated to the provided Internal Group ID.

intGroupId

GroupId

C

0..1

This IE shall contain the Internal Group ID associated to the provided External Group ID..

ueIdList

array(UeId)

C

1..N

This IE shall contain a list of the UE identifiers that belong to the provided Internal/External Group ID if they are required.

6.1.6.2.35 Type: NiddInformation

Table 6.1.6.2.35-1: Definition of type NiddInformation

Attribute name

Data type

P

Cardinality

Description

afId

string

M

1

The string identifying the AF as the owner of associated NIDD Configuration on T8 interface, which is carried in {scsAsId} URI variable in NIDD API (see clause 5.6.3.2.2 of 3GPP TS 29.122 [45]).

gpsi

Gpsi

O

0..1

Generic Public Subscription Identifier

extGroupId

ExternalGroupId

O

0..1

Indicates External Group Identifier which the user belongs to.

6.1.6.2.36 Type: CagData

Table 6.1.6.2.36-1: Definition of type CagData

Attribute name

Data type

P

Cardinality

Description

cagInfos

map(CagInfo)

M

0..N

A map (list of key-value pairs where PlmnId converted to string serves as key; see 3GPP TS 29.571 [7]) of CagInfo

An empty map indicates that for no PLMN CAG is subscribed and shall only be sent when provisioningTime is present (i.e. when acknowledgement from the UE is pending).

If provisioningTime is present (i.e. the acknowledgement from the UE is still pending), the complete map of CagInfo (i.e. for all PLMNs) shall be present; otherwise only the CagInfo relevant to the Serving PLMN should be present.

provisioningTime

DateTime

C

0..1

This attribute shall be present if the CagData is sent to the AMF while reception has not yet been acknowledged from the UE; otherwise shall be absent. Presence of this attribute indicates that the AMF needs to update the UE with the complete map of CagInfo.

This attribute serves as CAG information Subscription Change Indication

6.1.6.2.37 Type: CagInfo

Table 6.1.6.2.37-1: Definition of type CagInfo

Attribute name

Data type

P

Cardinality

Description

allowedCagList

array(CagId)

M

1..N

List of allowed CAG Ids.

cagOnlyIndicator

boolean

O

0..1

true indicates that the UE is restricted to only access 5GS via CAG cells;

absence and false indicate that the UE is not restricted to only access 5GS via CAG cells.

6.1.6.2.38 Type: AdditionalSnssaiData

Table 6.1.6.2.38-1: Definition of type AdditionalSnssaiData

Attribute name

Data type

P

Cardinality

Description

Applicability

requiredAuthnAuthz

boolean

O

0..1

Indicates whether an S-NSSAI is subject to Network Slice-Specific Authentication and Authorization:

– true: subject to network slice-specific authentication and authorization

– false, or absent: not subject to network slice-specific authentication and authorization

Nssaa

subscribedUeSliceMbr

SliceMbrRm

O

0..1

Indicates the subscribed UE-Slice-MBR for an S-NSSAI if the access type is 3GPP access.

Nsac

subscribedNsSrgList

array(NsSrg)

O

1..N

Indicates the subscribed Network Slice Silumtaneous Group values for an S-NSSAI.

(NOTE 1)

Nssrg

NOTE 1: If the NF consumer does not support the Nssrg feature, the subset of the Subscribed S-NSSAIs as defined in clause 5.15.12 of 3GPP TS 23.501 [2], may be included without providing the subscribedNsSrgList information. i.e. UDM may send default S-NSSAIs and subscribed S-NSSAIs sharing all the NSSRGs of the Default S-NSSAIs as part of the subscription information.

6.1.6.2.39 Type: VnGroupData

Table 6.1.6.2.39-1: Definition of type VnGroupData

Attribute name

Data type

P

Cardinality

Description

pduSessionTypes

PduSessionTypes

O

0..1

Allowed session types

dnn

Dnn

O

0..1

Data Network Name with Network Identifier only. (NOTE)

singleNssai

Snssai

O

0..1

Single Nssai

appDescriptors

array(AppDescriptor)

O

1..N

List of Application Descriptors

NOTE: Only a 1:1 mapping between DNN and 5G VN group is supported in this release

6.1.6.2.40 Type: AppDescriptor

Table 6.1.6.2.40-1: Definition of type AppDescriptor

Attribute name

Data type

P

Cardinality

Description

osId

OsId

O

0..1

OS identifier, does not include an OS version number

appId

string

O

0..1

Application identifier, does not include a version number for the application

6.1.6.2.41 Type: AppPortId

Table 6.1.6.2.41-1: Definition of type AppPortId

Attribute name

Data type

P

Cardinality

Description

destinationPort

Uint16

O

0..1

Indicates the receiving port of application in the receving device or AF.

originatorPort

Uint16

O

0..1

Indicates the sending port of application in sending device.

6.1.6.2.42 Type: LcsPrivacyData

Table 6.1.6.2.42-1: Definition of type LcsProfileData

Attribute name

Data type

P

Cardinality

Description

lpi

Lpi

O

0..1

If present, indicates the Location Privacy Indication (see 3GPP TS 23.273 [38] clause 5.4.2.3)

If absent, indicates that location for UE is allowed.

unrelatedClass

UnrelatedClass

O

0..1

Indicates Call/Session unrelated Classes for the user (see 3GPP TS 23.273 [38] clause 5.4.2.2.3).

plmnOperatorClasses

array(PlmnOperatorClass)

O

1..N

Indicates PLMN Operator Class for the user (see 3GPP TS 23.273 [38] clause 5.4.2.2.4).

6.1.6.2.43 Type: Lpi

Table 6.1.6.2.43-1: Definition of type Lpi

Attribute name

Data type

P

Cardinality

Description

locationPrivacyInd

LocationPrivacyInd

M

1

Indication of one of the following mutually exclusive global settings:

– Location is disallowed

– Location is allowed

validTimePeriod

ValidTimePeriod

O

0..1

If present, indicate Time period during which the Location Privacy Indication is valid.

If absent, indicates there is no time limitation.

6.1.6.2.44 Type: UnrelatedClass

Table 6.1.6.2.44-1: Definition of type UnrelatedClass

Attribute name

Data type

P

Cardinality

Description

defaultUnrelatedClass

DefaultUnrelatedClass

M

1

The default Call/Session unrelated Class subscription for unidentified value added LCS clients or AFs.

externalUnrelatedClass

ExternalUnrelatedClass

O

0..1

The Call/Session unrelated Class subscriptions for identified value added LCS Clients, AFs and value added LCS Client groups.

serviceTypeUnrelatedClasses

array(ServiceTypeUnrelatedClass)

O

1..X( NOTE 2)

The Call/Session unrelated Class subscriptions for identified service types for UE.( NOTE 1)

NOTE 1: It is possible that there are multiple serviceTypeUnrelatedClasses, whose maximum number is decied by total number of service type defined in 3GPP TS 22.071 [47],

NOTE 2: X indicates the total number of service type defined in 3GPP TS 22.071 [47].

6.1.6.2.45 Type: PlmnOperatorClass

Table 6.1.6.2.45-1: Definition of type PlmnOperatorClass

Attribute name

Data type

P

Cardinality

Description

lcsClientClass

LcsClientClass

M

1

Indicated the PLMN operator class of LCS client that are allowed to locate the particular UE (see 3GPP TS 23.273 [38] clause 5.4.2.2.4).

lcsClientIds

array(LcsClientId)

M

1..N

List of LCS clients for the corresponding LCS Client Class

6.1.6.2.46 Type: ValidTimePeriod

Table 6.1.6.2.46-1: Definition of type ValidTimePeriod

Attribute name

Data type

P

Cardinality

Description

startTime

DateTime

O

0..1

If present, indicates the start time

If absent, indicates there is no start time, and it shall be valid immediately.

(NOTE 1)

endTime

DateTime

O

0..1

If present, indicates the end time.

If absent, indicates there is no end time.

(NOTE 1)

NOTE 1: The end time shall be later than start time.

6.1.6.2.47 Type: LcsMoData

Table 6.1.6.2.47-1: Definition of type LcsMoData

Attribute name

Data type

P

Cardinality

Description

allowedServiceClasses

array(LcsMoServiceClass)

M

1..N

List of MO-LR services allowed for a UE subscriber

moAssistanceDataTypes

LcsBroadcastAssistanceTypesData

O

0..1

A list of one or more types of location assistance data that may be provided to the UE in the MO-LR procedure.

6.1.6.2.48 Type: EcRestrictionDataWb

Table 6.1.6.2.48-1: Definition of type EcRestrictionData

Attribute name

Data type

P

Cardinality

Description

ecModeARestricted

boolean

O

0..1

If present, indicates whether Enhanced Coverage Mode A is restricted or not.

true: Enhanced Coverage Mode A is restricted.

false or absent: Enhanced Coverage Mode A is not restricted.

ecModeBRestricted

boolean

O

0..1

If present, indicates whether Enhanced Coverage Mode B is restricted or not.

true: Enhanced Coverage Mode B is restricted.

false or absent: Enhanced Coverage Mode B is not restricted.

NOTE: At least one of the attributes ecModeARestricted and ecModeBRestricted shall be contained, and If the value of attribute ecModeARestricted is set to true, the value of attribute ecModeBRestricted shall be set to true.

6.1.6.2.49 Type: ExpectedUeBehaviourData

Table 6.1.6.2.49-1: Definition of type ExpectedUeBehaviourData

Attribute name

Data type

P

Cardinality

Description

stationaryIndication

StationaryIndication

O

0..1

Identifies whether the UE is stationary or mobile (see TS 23.502 [3] clause 4.15.6.3).

communicationDurationTime

DurationSec

O

0..1

Indicates for how long the UE will normally stay in CM-Connected for data transmission (see TS 23.502 [3] clause 4.15.6.3).

periodicTime

DurationSec

O

0..1

Identifies interval time of periodic communication (see TS 23.502 [3] clause 4.15.6.3).

scheduledCommunicationTime

ScheduledCommunicationTime

O

0..1

Identifies time and day of the week when the UE is available for communication (see TS 23.502 [3] clause 4.15.6.3).

scheduledCommunicationType

ScheduledCommunicationType

O

0..1

Indicates that the Scheduled Communication Type (see TS 23.502 [3] clause 4.15.6.3).

(NOTE 5)

expectedUmts

array(LocationArea)

O

1..N

Identifies the UE’s expected geographical movement. The attribute is only applicable in 5G (see TS 23.502 [3] clause 4.15.6.3).

(NOTE 3, NOTE 4)

trafficProfile

TrafficProfile

O

0..1

Identifies the type of data transmission: single packet transmission (UL or DL), dual packet transmission (UL with subsequent DL or DL with subsequent UL), multiple packets transmission

batteryIndication

BatteryIndication

O

0..1

Indicates the power consumption type(s) of the UE (see TS 23.502 [3] clause 4.15.6.3).

validityTime

DateTime

O

0..1

If present, identifies when the expected UE behaviour parameters expire and shall be deleted locally if it expire (see TS 23.502 [3] clause 4.15.6.3).

(NOTE 2)

NOTE 1: At least one of optional parameters (expect for validityTime) above shall be present.

NOTE 2: If this attribute is omitted, no expiry for the expected UE behaviour parameters applies.

NOTE 3: The first instance of the attribute represents the start of the location, and the last one represents the stop of the location.

NOTE 4: The parameter expectedUmts is only used by AMF.

NOTE 5: The value of attribute "scheduledCommunicationType" shall be used together with the value of "scheduledCommunicationTime".

6.1.6.2.50 Void
6.1.6.2.51 Void
6.1.6.2.52 Type: SuggestedPacketNumDl

Table 6.1.6.2.52-1: Definition of type SuggestedPacketNumDl

Attribute name

Data type

P

Cardinality

Description

suggestedPacketNumDl

integer

M

1

Value in number of packets.

validityTime

DateTime

O

0..1

If present, identifies the time to which the Network Configuration Parameters expire and shall be deleted locally if it expire (see TS 23.502 [3] clause 4.15.6.3a).

(NOTE 1)

NOTE 1: If this attribute is omitted, no expiry for the expected UE behaviour parameters applies.

6.1.6.2.53 Void
6.1.6.2.54 Type: FrameRouteInfo

Table 6.1.6.2.54-1: Definition of type FrameRouteInfo

Attribute name

Data type

P

Cardinality

Description

ipv4Mask

IPv4AddrMask

C

0..1

Indicates IPv4 address mask.

ipv6Prefix

Ipv6Prefix

C

0..1

Indicates IPv6 prefix.

NOTE: Either ipv4Mask or ipv6Prefix shall be present.

6.1.6.2.55 Type: SorUpdateInfo

Table 6.1.6.2.55-1: SorUpdateInfo

Attribute name

Data type

P

Cardinality

Description

vplmnId

PlmnId

M

1

Serving node PLMN identity.

supportedFeatures

SupportedFeatures

O

0..1

See clause 6.1.8

6.1.6.2.56 Type: EnhancedCoverageRestrictionData

Table 6.1.6.2.56-1: Definition of type EnhancedCoverageRestrictionData

Attribute name

Data type

P

Cardinality

Description

plmnEcInfoList

array(PlmnEcInfo)

O

1..N

It may indicate a complete list of serving PLMNs where Enhanced Coverage Restriction shall be allowed and the detailed enhanced coverage restriction configuration under per the PLMN.

6.1.6.2.57 Type: EdrxParameters

Table 6.1.6.2.57-1: EdrxParameters

Attribute name

Data type

P

Cardinality

Description

ratType

RatType

M

1

This IE shall indicate the RAT type which eDRX value are applicable to.

Only the following values are allowed:

"EUTRA"
"NBIOT"
"LTE-M"
"NR"
"NR_REDCAP"

edrxValue

string

M

1

This IE shall indicate eDRX Cycle length value, it shall be encoded as a string of bits 4 to 1 of octet 3 in the "Extended DRX parameter" IE (see Figure 10.5.5.32 of 3GPP TS 24.008 [46]).

Pattern: ‘^([0-1]{4})$’

NOTE: The relationship between values of ratType and edrxValue shall be in line with clause 10.5.5.32 of 3GPP TS 24.008 [46].

6.1.6.2.58 Type: PtwParameters

Table 6.1.6.2.58-1: PtwParameters

Attribute name

Data type

P

Cardinality

Description

operationMode

OperationMode

M

1

This IE shall indicate the Operation Mode which PTW value are applicable to.

ptwValue

string

M

1

This IE shall indicate RAT specific Subscribed Paging Time Window length value, it shall be encoded as a string of bits 8 to 5 of octet 3 in the "Extended DRX parameter" IE (see Figure 10.5.5.32 of 3GPP TS 24.008 [46]).

Pattern: ‘^([0-1]{4})$’

NOTE: The relationship between values of operationMode and ptwValue shall be in line with clause 10.5.5.32 of 3GPP TS 24.008 [46].

6.1.6.2.59 Void
6.1.6.2.60 Void
6.1.6.2.61 Type: Void
6.1.6.2.62 Type: ExternalUnrelatedClass

Table 6.1.6.2.62-1: Definition of type ExternalUnrelatedClass

Attribute name

Data type

P

Cardinality

Description

lcsClientExternals

array(LcsClientExternal)

O

1..N

The list of Call/session Unrelated Class identified by LCS client in the external LCS client list for the list

afExternals

array(AfExternal)

O

1..N

The list of Call/session Unrelated Class identified by AF in the external LCS client list

lcsClientGroupExternals

array(LcsClientGroupExternal)

O

1..N

The list of Call/session Unrelated Class identified by LCS client group in the external LCS client list

6.1.6.2.63 Type: AfExternal

Table 6.1.6.2.63-1: Definition of type AfExternal

Attribute name

Data type

P

Cardinality

Description

afId

AfId

O

0..1

AF Identifier (see 3GPP TS 23.273 [38] clause 5.4.2.2.3)

allowedGeographicArea

array(GeographicArea)

O

1..N

Indicates Geographical area where positioning is allowed (see 3GPP TS 23.273 [38] clause 5.4.2.2.3).

privacyCheckRelatedAction

PrivacyCheckRelatedAction

O

0..1

Indicates action related to privacy check.

(NOTE)

validTimePeriod

ValidTimePeriod

O

0..1

Time period when positioning is allowed

NOTE: "LOCATION_ALLOWED_WITHOUT_NOTIFICATION" is default value and "LOCATION_NOT_ALLOWED" is not optional for the attribute.

6.1.6.2.64 Type: LcsClientExternal

Table 6.1.6.2.64-1: Definition of type LcsClientExternal

Attribute name

Data type

P

Cardinality

Description

lcsClientId

LcsClientId

O

0..1

Lcs Client Identifier (see 3GPP TS 23.273 [38] clause 5.4.2.2.3)

allowedGeographicArea

array(GeographicArea)

O

1..N

Indicates Geographical area where positioning is allowed (see 3GPP TS 23.273 [38] clause 5.4.2.2.3).

privacyCheckRelatedAction

PrivacyCheckRelatedAction

O

0..1

Indicates action related to privacy check.

(NOTE)

validTimePeriod

ValidTimePeriod

O

0..1

Time period when positioning is allowed

NOTE: "LOCATION_ALLOWED_WITHOUT_NOTIFICATION" is default value and "LOCATION_NOT_ALLOWED" is not optional for the attribute.

6.1.6.2.65 Type: LcsClientGroupExternal

Table 6.1.6.2.65-1: Definition of type LcsClientGroupExternal

Attribute name

Data type

P

Cardinality

Description

lcsClientGroupId

ExtGroupId

O

0..1

LCS Client Group Identifier

allowedGeographicArea

array(GeographicArea)

O

1..N

Indicates Geographical area where positioning is allowed (see 3GPP TS 23.273 [38] clause 5.4.2.2.3).

privacyCheckRelatedAction

PrivacyCheckRelatedAction

O

0..1

Indicates action related to privacy check.

(NOTE)

validTimePeriod

ValidTimePeriod

O

0..1

Time period when positioning is allowed

NOTE: "LOCATION_ALLOWED_WITHOUT_NOTIFICATION" is default value and "LOCATION_NOT_ALLOWED" is not optional for the attribute.

6.1.6.2.66 Type: ServiceTypeUnrelatedClass

Table 6.1.6.2.66-1: Definition of type ServiceTypeUnrelatedClass

Attribute name

Data type

P

Cardinality

Description

serviceType

LcsServiceType

M

1

One of the service type defined in 3GPP TS 22.071 [47].

allowedGeographicArea

array(GeographicArea)

O

1..N

Indicates Geographical area where positioning is allowed (see 3GPP TS 23.273 [38] clause 5.4.2.2.3).

privacyCheckRelatedAction

PrivacyCheckRelatedAction

O

0..1

Indicates action related to privacy check.

(NOTE)

codeWordInd

CodeWordInd

O

0..1

Indication that codeword shall be checked in UE or one or more codeword values to be checked in GMLC

validTimePeriod

ValidTimePeriod

O

0..1

Time period when positioning is allowed

codeWordList

array(CodeWord)

C

1..N

This IE shall be present when codeWordInd is " CODEWORD_CHECK_IN_GMLC".

When present, this IE shall contain one or more CodeWords used by GMLC for verification.

NOTE: "LOCATION_ALLOWED_WITHOUT_NOTIFICATION" is default value and "LOCATION_NOT_ALLOWED" is not optional for the attribute.

6.1.6.2.67 Type: UeId

Table 6.1.6.2.67-1: Definition of type UeId

Attribute name

Data type

P

Cardinality

Description

supi

Supi

M

1

This IE shall indicate the SUPI.

gpsiList

array(gpsi)

O

1..N

This IE shall indicate a list of GPSIs that is associated with the SUPI.

6.1.6.2.68 Type: DefaultUnrelatedClass

Table 6.1.6.2.68-1: Definition of type DefaultUnrelatedClass

Attribute name

Data type

P

Cardinality

Description

allowedGeographicArea

array(GeographicArea)

O

1..N

Indicates Geographical area where positioning is allowed (see 3GPP TS 23.273 [38] clause 5.4.2.2.3).

privacyCheckRelatedAction

PrivacyCheckRelatedAction

O

0..1

Indicates action related to privacy check.

(NOTE)

codeWordInd

CodeWordInd

O

0..1

Indication that codeword shall be checked in UE or one or more codeword values to be checked in GMLC

validTimePeriod

ValidTimePeriod

O

0..1

Time period when positioning is allowed

codeWordList

array(CodeWord)

C

1..N

This IE shall be present when codeWordInd is present with value "CODEWORD_CHECK_IN_GMLC".

When present, this IE shall contain one or more CodeWords used by GMLC for verification.

NOTE: "LOCATION_NOT_ALLOWED" is default value and only values "LOCATION_NOT_ALLOWED", "LOCATION_ALLOWED_WITHOUT_NOTIFICATION", "LOCATION_ALLOWED_WITHOUT_RESPONSE", "LOCATION_RESTRICTED_WITHOUT_RESPONSE" can be contained.

6.1.6.2.69 Type: ContextInfo

Table 6.1.6.2.69-1: Definition of type ContextInfo

Attribute name

Data type

P

Cardinality

Description

origHeaders

array(string)

O

1..N

Headers received by the UDM from NFs consuming Nudm services. The encoding of the header shall comply with clause 3.2 of IETF RFC 7230 [50]

requestHeaders

array(string)

O

1..N

Headers sent by the UDM to NFs (e.g. AMF). The encoding of the header shall comply with clause 3.2 of IETF RFC 7230 [50]

6.1.6.2.70 Type: UeContextInAmfData

Table 6.1.6.2.70-1: Definition of type UeContextInAmfData

Attribute name

Data type

P

Cardinality

Description

Applicability

epsInterworkingInfo

EpsInterworkingInfo

O

0..1

This IE contains the associations between APN/DNN and PGW-C+SMF selected by the AMF for EPS interworking.

amfInfo

array(AmfInfo)

O

0..2

This IE shall contain the list of AmfInfo.

ENA

NOTE: If sdmSubscription contains nfChangeFilter flag, then the UDM shall suppress the change notification for the epsInterworkingInfo

6.1.6.2.71 Type: V2xSubscriptionData

Table 6.1.6.2.71-1: Definition of type V2xSubscriptionData

Attribute name

Data type

P

Cardinality

Description

nrV2xServicesAuth

NrV2xAuth

O

0..1

Indicates whether the UE is authorized to use the NR sidelink for V2X services.

lteV2xServicesAuth

LteV2xAuth

O

0..1

Indicates whether the UE is authorized to use the LTE sidelink for V2X services.

nrUePc5Ambr

BitRate

O

0..1

Indicates UE-PC5-AMBR for V2X communication over PC5 reference point for NR PC5.

ltePc5Ambr

BitRate

O

0..1

Indicates UE-PC5-AMBR for V2X communication over PC5 reference point for LTE PC5.

6.1.6.2.72 Type: LcsBroadcastAssistanceTypesData

Table 6.1.6.2.72-1: Definition of type LcsBroadcastAssistanceTypesData

Attribute name

Data type

P

Cardinality

Description

locationAssistanceType

Bytes

M

1

This IE contains a bitmap ,encoded as a base64 string, which indicates the broadcast location assistance data types for which the UE is subscribed to receive ciphering keys used to decipher broadcast assistance data. A bit set to 1 indicates that the UE is subscribed to receive ciphering keys applicable to corresponding positioning SIB type.

The mapping of the bits to the positioning SIB types is as follows:

— bit 8 in the first octet maps to positioning SIB Type 1-1

— bit 7 in the first octet maps to positioning SIB Type 1-2

— bit 6 in the first octet maps to positioning SIB Type 1-3

— bit 5 in the first octet maps to positioning SIB Type 1-4

— bit 4 in the first octet maps to positioning SIB Type 1-5

— bit 3 in the first octet maps to positioning SIB Type 1-6

— bit 2 in the first octet maps to positioning SIB Type 1-7

— bit 1 in the first octet maps to positioning SIB Type 1-8

— bit 8 in the second octet maps to positioning SIB Type 2-1

— bit 7 in the second octet maps to positioning SIB Type 2-2

— bit 6 in the second octet maps to positioning SIB Type 2-3

— bit 5 in the second octet maps to positioning SIB Type 2-4

— bit 4 in the second octet maps to positioning SIB Type 2-5

— bit 3 in the second octet maps to positioning SIB Type 2-6

— bit 2 in the second octet maps to positioning SIB Type 2-7

— bit 1 in the second octet maps to positioning SIB Type 2-8

— bit 8 in the third octet maps to positioning SIB Type 2-9

— bit 7 in the third octet maps to positioning SIB Type 2-10

— bit 6 in the third octet maps to positioning SIB Type 2-11

— bit 5 in the third octet maps to positioning SIB Type 2-12

— bit 4 in the third octet maps to positioning SIB Type 2-13

— bit 3 in the third octet maps to positioning SIB Type 2-14

— bit 2 in the third octet maps to positioning SIB Type 2-15

— bit 1 in the third octet maps to positioning SIB Type 2-16

— bit 8 in the fourth octet maps to positioning SIB Type 2-17

— bit 7 in the fourth octet maps to positioning SIB Type 2-18

— bit 6 in the fourth octet maps to positioning SIB Type 2-19

— bit 5 in the fourth octet maps to positioning SIB Type 2-20

— bit 4 in the fourth octet maps to positioning SIB Type 2-21

— bit 3 in the fourth octet maps to positioning SIB Type 2-22

— bit 2 in the fourth octet maps to positioning SIB Type 2-23

— bit 1 in the fourth octet maps to positioning SIB Type 2-24

— bit 7 in the fifth octet maps to positioning SIB Type 2-25

— bit 6 in the fifth octet maps to positioning SIB Type 3-1

— bit 5 in the fifth octet maps to positioning SIB Type 4-1

— bit 4 in the fifth octet maps to positioning SIB Type 5-1

— bit 3 in the fifth octet maps to positioning SIB Type 6-1

— bit 2 in the fifth octet maps to positioning SIB Type 6-2

— bit 1 in the fifth octet maps to positioning SIB Type 6-3

Any unassigned bits are spare and shall be coded as zero. Non-included bits shall be treated as being coded as zero.

NOTE: The mapping of posSibType to assistance data element is further described in clause 7.2 of 3GPP TS 37.355 [56].

6.1.6.2.73 Type: DatasetNames

Table 6.1.6.2.73-1: Definition of type DatasetNames

Data type

Cardinality

Description

array(DataSetName)

2..N

List of names of the data sets

6.1.6.2.74 Type: PlmnRestriction

Table 6.1.6.2.74-1: Definition of type PlmnRestriction

Attribute name

Data type

P

Cardinality

Description

Applicability

ratRestrictions

array(RatType)

O

0..N

List of RAT Types that are restricted in 5GC and EPC; see 3GPP TS 29.571 [7]

Contains unique items

forbiddenAreas

array(Area)

O

0..N

List of forbidden areas in 5GS

serviceAreaRestriction

ServiceAreaRestriction

O

0..1

Subscribed Service Area Restriction

coreNetworkTypeRestrictions

array(CoreNetworkType)

O

0..N

List of Core Network Types that are restricted.

The use of the value "5GC" is deprecated on Nudm and shall be discarded by the receiving AMF.

accessTypeRestrictions

array(AccessType)

O

0..2

List of Access Types that are restricted.

primaryRatRestrictions

array(RatType)

O

0..N

List of RAT Types that are restricted for use as primary RAT in 5GC and EPC; see 3GPP TS 29.571 [7]

Contains unique items

secondaryRatRestrictions

array(RatType)

O

0..N

List of RAT Types that are restricted for use as secondary RAT in 5GC and EPC; see 3GPP TS 29.571 [7]

Contains unique items

6.1.6.2.75 Type: PcfSelectionAssistanceInfo

Table 6.1.6.2.75-1: Definition of type PcfSelectionAssistanceInfo

Attribute name

Data type

P

Cardinality

Description

dnn

Dnn

M

1

Identifies a DNN.

singleNssai

Snssai

M

1

Identifies a S-NSSAI.

6.1.6.2.76 Type: ProseSubscriptionData

Table 6.1.6.2.76-1: Definition of type ProseSubscriptionData

Attribute name

Data type

P

Cardinality

Description

proseServiceAuth

ProseServiceAuth

O

0..1

Indicates whether the UE is authorized to use ProSe Direct Discovery, ProSe Direct Communication, or both.

nrUePc5Ambr

BitRate

O

0..1

Indicates the AMBR of UE’s NR sidelink (i.e. PC5) communication for ProSe services.

proseAllowedPlmn

array(ProSeAllowedPlmn)

O

1..N

Contains a list of the ProSeAllowedPlmn which contain the PLMN identities where the Prose services are authorised to use and the authorised Prose services on these given PLMNs.

6.1.6.2.77 Type: IpIndex

Table 6.1.6.2.77-1: Definition of type IpIndex as a list of non-exclusive alternatives

Data Type

Cardinality

Description

integer

1

IP Index expressed as an integer value

string

1

IP Index expressed as a string

6.1.6.2.78 Type: AerialUeSubscriptionInfo

Table 6.1.6.2.78-1: Definition of type AerialUeSubscriptionInfo

Attribute name

Data type

P

Cardinality

Description

Applicability

aerialUeInd

AerialUeIndication

M

1

This UE shall indicate Aerial service for the UE is allowed or not allowed.

3gppUavId

Gpsi

C

0..1

When present, this IE shall contain the 3GPP UAV ID, it is encoded as GPSI in the format of External Identifier.

If aerialUeInd indicates "AERIAL_UE_ALLOWED", this IE shall be present.

6.1.6.2.79 Type: SmSubsData

Table 6.1.6.2.79-1: Definition of type SmSubsData as a list of alternatives

Data type

Cardinality

Description

Applicability

array(SessionManagementSubscriptionData)

1..N

Individual Session Management Subscription Data.

ExtendedSmSubsData

1

Extended Session Management Subscription Data.

SharedSmSubsData

6.1.6.2.80 Type: ExtendedSmSubsData

Table 6.1.6.2.80-1: Definition of type ExtendedSmSubsData

Attribute name

Data type

P

Cardinality

Description

Applicability

individualSmSubsData

array(SessionManagementSubscriptionData)

O

1..N

individual Session Management Subscription Data

(NOTE 1)

SharedSmSubsData

sharedSmSubsDataIds

array(SharedDataId)

M

1..N

Identifier of shared data

SharedSmSubsData

NOTE 1: A given UE-individual SessionManagementSubscriptionData (within individualSmSubsData) may clash with a shared SessionManagementSubscriptionData (i.e. both have the same singleNssai value). In this case the clashing attributes of the UE-individual SessionManagementSubscriptionData take precedence unless treatment instructions indicate otherwise.

6.1.6.2.81 Type: AmfInfo

Table 6.1.6.2.81-1: Definition of type UeContextInAmfData

Attribute name

Data type

P

Cardinality

Description

amfInstanceId

NfInstanceId

M

1

The identity the AMF uses to register in the NRF

guami

Guami

M

1

This IE shall contain the serving AMF’s GUAMI.

accessType

AccessType

M

1

This IE shall contain the access type

6.1.6.2.82 Type: ProSeAllowedPlmn

Table 6.1.6.2.82-1: Definition of type ProSeAllowedPlmn

Attribute name

Data type

P

Cardinality

Description

visitedPlmn

PlmnId

M

1

This IE shall contain the PLMN identity where the UE is authorised for 5G ProSe services.

proseDirectAllowed

array(ProseDirectAllowed)

O

1..N

When present, this IE contains the 5G ProSe Direct services are authorised to use in the PLMN indicated by visitedPlmn for the UE.

If this IE is absent, it indicates that all the 5G ProSe Direct services are authorised to use in the PLMN indicated by visitedPlmn for the UE.

6.1.6.2.83 Type: ImmediateReport

Table 6.1.6.2.83-1: Definition of type ImmediateReport as a list of alternatives

Data type

Cardinality

Description

Applicability

SubscriptionDataSets

1

UE based subscription data sets that to be monitored in SdmSubscription.

array(SharedData)

1..N

Shared subscription data sets that to be monitored in SdmSubscription.

6.1.6.2.84 Type: MbsSubscriptionData

Table 6.1.6.2.84-1: Definition of type MbsSubscriptionData

Attribute name

Data type

P

Cardinality

Description

mbsAllowed

boolean

C

0..1

This IE indicates whether the UE is authorized to receive multicast MBS session data.

When present, this IE shall be set as following:

– true: the UE is authorized to receive multicast MBS session data

– false (default): UE is not authorized to receive multicast MBS session data

mbsSessionIdList

array(MbsSessionId)

C

1..N

This IE shall be present if available and the mbsAllowed attribute is set to "true".

If present, this IE identifies the MBS Session(s) that the UE is allowed to join.

6.1.6.2.85 Type: UcSubscriptionData

Table 6.1.6.2.85-1: Definition of type UcSubscriptionData

Attribute name

Data type

P

Cardinality

Description

userConsentPerPurposeList

map(UserConsent)

O

1..N

A map user consent (list of key-value pairs where UcPurpose serves as key; see clause 6.1.6.3.20).

6.1.6.2.86 Type: UeContextInSmfDataSubFilter

Table 6.1.6.2.86-1: Definition of type UeContextInSmfDataSubFilter

Attribute name

Data type

P

Cardinality

Description

dnnList

array(Dnn)

C

1..N

This IE shall be present to get the pduSesion and pgwInfo in UeContextInSmfData for specific DNN(s).

When present, the UDM shall notify the changes of pduSesion and pgwInfo in UeContextInSmfData for the indicated DNN(s).

When this IE is not present, the UDM will not notify changes of pduSesion and pgwInfo.

snssaiList

array(Snssai)

O

1..N

This IE may be present when dnnList IE is present.

When present, the UDM shall notify the changes of pduSesion and pgwInfo in UeContextInSmfData for the DNN(s) that are associated the indicated S-NSSAIs(s).

emergencyInd

boolean

C

0..1

This IE shall be present and set to value "true" for changes on the emergencyInfo in UeContextInSmfData.

When present, this IE shall indicate whether the UDM shall notify the changes on emergencyInfo in UeContextInSmfData:

– true: changes on emergencyInfo to be notified

– false (default) changes on emergencyInfo not to be notified.

6.1.6.2.87 Type: UeIdentifiers

Table 6.1.6.2.87-1: Definition of type UeIdentifiers

Attribute name

Data type

P

Cardinality

Description

ueIdList

map(SupiInfo)

C

1..N

A map (list of key-value pairs where Gpsi serves as key; see 3GPP TS 29.571 [7]) of arrays of Supi.

6.1.6.2.88 Type: SupiInfo

Table 6.1.6.2.88-1: Definition of type SupiInfo

Attribute name

Data type

P

Cardinality

Description

supiList

array(Supi)

M

0..N

This IE shall indicate a list of SUPIs that is associated with the GPSI.

An empty array shall be returned if there is no SUPIs associated with the GPSI.

6.1.6.3 Simple data types and enumerations

6.1.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.1.6.3.2 Simple data types

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

Table 6.1.6.3.2-1: Simple data types

Type Name

Type Definition

Description

DefaultDnnIndicator

boolean

Indicates whether a DNN is the default DNN

LboRoamingAllowed

boolean

This flag indicates whether local breakout is allowed when roaming.

UeUsageType

integer

Indicates the usage characteristics of the UE, enables the selection of a specific Dedicated Core Network for EPS interworking

MpsPriorityIndicator

boolean

Indicates whether UE is subscribed to multimedia priority service

McsPriorityIndicator

boolean

Indicates whether UE is subscribed to mission critical service

3GppChargingCharacteristics

string

16-bit string identifying charging characteristics as specified in 3GPP TS 32.255 [11] Annex A and 3GPP TS 32.298 [12] clause 5.1.2.2.7, in hexadecimal representation. Each character in the string shall take a value of "0" to "9" or "A" to "F" and shall represent 4 bits. The most significant character representing the 4 most significant bits of the charging characteristics shall appear first in the string, and the character representing the 4 least significant bits of the charging characteristics shall appear last in the string.

Example:

The charging characteristic 0x123A shall be encoded as "123A".

MicoAllowed

boolean

Indicates whether MICO mode is allowed for the UE.

SmsSubscribed

boolean

Indicates whether the UE subscription allows SMS delivery over NAS.

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}-.+$"

IwkEpsInd

boolean

Indicates whether Interworking with EPS is supported

SecuredPacket

string

Indicates the secured packet as specified in 3GPP TS 24.501 [27]. It is encoded using base64 and represented as a String.

Format: byte

UpuRegInd

boolean

true indicates that re-registration is requested after the successful UE parameters update.

ExtGroupId

string

String containing a External Group ID.

Pattern: "^extgroupid-[^@]+@[^@]+$"

NbIoTUePriority

integer

Unsigned integer indicating the NB-IoT UE Priority (see clause 5.31.17 of 3GPP TS 23.501 [8]), the value is between 0 and 255 and lower value indicates higher priority.

CodeWord

string

Indicates the codeword as specified in 3GPP TS 23.273 [38] clause 5.4.2.2.3.

AfId

string

AF Identifier (see 3GPP TS 23.273 [38] clause 5.4.2.2.3)

LcsClientId

string

Lcs Client Identifier (see 3GPP TS 23.273 [38] clause 5.4.2.2.3)

SorTransparentContainer

Bytes

String with format "byte" as defined in OpenAPI Specification [14], i.e. base64-encoded characters, encoding the "SOR transparent container" IE as specified in clause 9.11.3.51 of 3GPP TS 24.501 [27] (starting from octet 1).

UpuTransparentContainer

Bytes

String with format "byte" as defined in OpenAPI Specification [14], i.e. base64-encoded characters, encoding the "UE Parameters Update transparent container" IE as specified in clause 9.11.3.53A of 3GPP TS 24.501 [27] (starting from octet 1).

SorCmci

Bytes

String with format "byte" as defined in OpenAPI Specification [14], i.e. base64-encoded characters, encoding the "SOR-CMCI " IE as specified in figure 9.11.3.51.7 of 3GPP TS 24.501 [27] (starting from octet 1).

6.1.6.3.3 Enumeration: DataSetName

Table 6.1.6.3.3-1: Enumeration DataSetName

Enumeration value

Description

"AM"

Access and Mobility Subscription Data

"SMF_SEL"

SMF Selection Subscription Data

"UEC_SMF"

UE Context in SMF Data

"UEC_SMSF"

UE Context in SMSF Data

"SMS_SUB"

SMS Subscription Data

"SM"

Session Management Subscription Data

"TRACE"

Trace Data

"SMS_MNG"

SMS Management Subscription Data

"LCS_PRIVACY"

LCS Privacy Subscription Data

"LCS_MO"

LCS Mobile Originated Subscription Data

"UEC_AMF"

UE Context in AMF Data

"V2X"

V2X Subscription Data

"LCS_BCA"

LCS Broadcast Assistance Subscription Data

"PROSE"

ProSe Service Subscription Data

"UC"

User Consent Data

"MBS"

5MBS subscription data

NOTE: The current naming conventions for Enumerations (uppercase with underscore), when their intended usage is for query parameters is not consistent with the naming conventions for URI components (lowercase with hyphen).

6.1.6.3.4 Void
6.1.6.3.5 Void
6.1.6.3.6 Void
6.1.6.3.7 Enumeration: PduSessionContinuityInd

Table 6.1.6.3.7-1: Enumeration PduSessionContinuityInd

Enumeration value

Description

"MAINTAIN_PDUSESSION"

Maintain the PDU session

"RECONNECT_PDUSESSION"

Disconnect the PDU session with a reactivation request

"RELEASE_PDUSESSION"

Disconnect PDU session without reactivation request

6.1.6.3.8 Enumeration: LocationPrivacyInd

Table 6.1.6.3.8-1: Enumeration LocationPrivacyInd

Enumeration value

Description

"LOCATION_DISALLOWED"

Location for UE is disallowed

"LOCATION_ALLOWED"

Location for UE are allowed

6.1.6.3.9 Enumeration: PrivacyCheckRelatedAction

Table 6.1.6.3.9-1: Enumeration PrivacyCheckRelatedAction

Enumeration value

Description

"LOCATION_NOT_ALLOWED"

Location not allowed

"LOCATION_ALLOWED_WITH_NOTIFICATION"

Location allowed with notification

"LOCATION_ALLOWED_WITHOUT_NOTIFICATION"

Location allowed without notification

"LOCATION_ALLOWED_WITHOUT_RESPONSE"

Location with notification and privacy verification; location allowed if no response

"LOCATION_RESTRICTED_WITHOUT_RESPONSE"

Location with notification and privacy verification; location restricted if no response

6.1.6.3.10 Enumeration: LcsClientClass

Table 6.1.6.3.10-1: Enumeration LcsClientClass

Enumeration value

Description

"BROADCAST_SERVICE"

LCS client broadcasting location related information

"OM_IN_HPLMN"

O&M LCS client in the HPLMN

"OM_IN_VPLMN"

O&M LCS client in the VPLMN

"ANONYMOUS_LOCATION_SERVICE"

LCS client recording anonymous location information

"SPECIFIC_SERVICE"

LCS Client supporting a bearer service, teleservice or supplementary service to the target UE

6.1.6.3.11 Enumeration: LcsMoServiceClass

Table 6.1.6.3.11-1: Enumeration LcsMoServiceClass

Enumeration value

Description

"BASIC_SELF_LOCATION"

UE requests own location

"AUTONOMOUS_SELF_LOCATION"

UE requests location assistance data

"TRANSFER_TO_THIRD_PARTY"

UE requests transfer of own location to another LCS Client

6.1.6.3.12 Enumeration: OperationMode

Table 6.1.6.3.12-1: Enumeration OperationMode

Enumeration value

Description

"WB_S1"

WB-S1 mode

"NB_S1"

NB-S1 mode

"WB_N1"

WB-N1 mode

"NB_N1"

NB-N1 mode

6.1.6.3.13 Enumeration: SorUpdateIndicator

Table 6.1.6.3.13-1: Enumeration SorUpdateIndicator

Enumeration value

Description

"INITIAL_REGISTRATION"

NAS registration type "Initial Registration"

"EMERGENCY_REGISTRATION"

NAS registration type "Emergency Registration"

6.1.6.3.14 Enumeration: CodeWordInd

Table 6.1.6.3.14-1: Enumeration CodeWordInd

Enumeration value

Description

"CODEWORD_CHECK_IN_UE"

codeword shall be checked in UE

"CODEWORD_CHECK_IN_GMLC"

one or more codeword values to be checked in GMLC

6.1.6.3.15 Enumeration: MdtUserConsent

Table 6.1.6.3.15-1: Enumeration MdtUserConsent

Enumeration value

Description

"CONSENT_NOT_GIVEN"

It shall indicate the user has given his consent for MDT activation.

"CONSENT_GIVEN"

It shall indicate the user hasn’t given his consent for MDT activation.

6.1.6.3.16 Enumeration: SharedDataTreatmentInstruction

Table 6.1.6.3.16-1: Enumeration SharedDataTreatmentInstruction

Enumeration value

Description

"USE_IF_NO_CLASH"

If the attribute is not present in the individual data (no clash), the value of the shared data attribute shall be used. Otherwise the individual data takes precedence. (default)

"OVERWRITE"

The value of the shared data attribute shall be used (even when clashing with individual data).
If the shared data attribute is absent, the value of the individual attribute (if any) shall not be used, i.e. the attribute shall be handled as being absent.

"MAX"

If no clash (i.e. individual data is absent) the shared data attribute value shall be used. Otherwise the higher value shall be used.

(NOTE)

"MIN"

If no clash (i.e. individual data is absent) the shared data attribute value shall be used. Otherwise the lower value shall be used.

(NOTE)

NOTE: Treatment instructions "MIN" and "MAX" are applicable to attributes that can take numeric values.

6.1.6.3.17 Enumeration: GpsiType

Table 6.1.6.3.17-1: Enumeration GpsiType

Enumeration value

Description

"MSISDN"

GPSI type of MSISDN

"EXT_ID"

GPSI type of external identity

"EXT_GROUP_ID"

GPSI type of external group identity

6.1.6.3.18 Enumeration: AerialUeIndication

Table 6.1.6.3.18-1: Enumeration AerialUeIndication

Enumeration value

Description

"AERIAL_UE_ALLOWED"

Aerial service for the UE is allowed.

"AERIAL_UE_NOT_ALLOWED"

Aerial service for the UE is not allowed.

6.1.6.3.19 Enumeration: ProseDirectAllowed

Table 6.1.6.3.19-1: Enumeration ProseDirectAllowed

Enumeration value

Description

"ANNOUNCE"

It indicates that the user is allowed to announce in the corresponding PLMN for open 5G Direct Discovery Model A.

"MONITOR"

It indicates that the user is allowed to monitor in the corresponding PLMN for open 5G Direct Discovery Model A.

"RESTRICTD_ANNOUNCE"

It indicates that the user is allowed to announce in the corresponding PLMN for restricted 5G ProSe Direct Discovery Model A.

"RESTRICTD_MONITOR"

It indicates that the user is allowed to monitor in the corresponding PLMN for restricted 5G ProSe Direct Discovery Model A.

"DISCOVERER"

It indicates that the user is allowed to perform discoverer operation in the corresponding PLMN for restricted 5G ProSe Direct Discovery Model B.

"DISCOVEREE"

It indicates that the user is allowed to perform discoveree operation in the corresponding PLMN for restricted 5G ProSe Direct Discovery Model B.

"BROADCAST"

It indicates that the user is allowed to perform Broadcast mode 5G ProSe Direct Communication for NR PC5 in the corresponding PLMN.

"GROUPCAST"

It indicates that the user is allowed to perform Groupcast mode 5G ProSe Direct Communication for NR PC5 in the corresponding PLMN.

"UNICAST"

It indicates that the user is allowed to perform Unicast mode 5G ProSe Direct Communication for NR PC5 in the corresponding PLMN.

"LAYER2_RELAY"

It indicates that the user is allowed to act as a 5G ProSe Layer-2 UE-to-Network Relay.

"LAYER3_RELAY"

It indicates that the user is allowed to act as a 5G ProSe Layer-3 UE-to-Network Relay.

6.1.6.3.20 Enumeration: UcPurpose

Table 6.1.6.3.20-1: Enumeration UcPurpose

Enumeration value

Description

"ANALYTICS"

User consent for analytics.

"MODEL_TRAINING"

User consent for model training.

"NW_CAP_EXPOSURE"

User consent for network capability exposure.

"EDGEAPP_UE_LOCATION"

User consent for the manipulation of UE information for the purpose of UE Location retrieval by the EDGEAPP EAS entity.

6.1.6.3.21 Enumeration: UserConsent

Table 6.1.6.3.21-1: Enumeration UserConsent

Enumeration value

Description

"CONSENT_NOT_GIVEN"

It shall indicate the user hasn’t given his consent.

"CONSENT_GIVEN"

It shall indicate the user has given his consent.