SMF Notification Subscriptions

/subscriptions

POST

Create a new Individual SMF Notification Subscription resource.

Individual SMF Notification Subscription

/subscriptions/{subId}

GET

Read an Individual SMF Notification Subscription resource.

PUT

Modify an existing Individual SMF Notification Subscription resource.

DELETE

Delete an Individual SMF Notification Subscription resource and cancel the related subscription.

apiRoot

string

See clause 5.1

n/a

NsmfEventExposure

M

1

Create a new Individual SMF Notification Subscription resource.

NsmfEventExposure

M

1

201 Created

The creation of an Individual SMF Notification Subscription resource is confirmed and a representation of that resource is returned.

NOTE: The mandatory HTTP error status codes for the POST method listed in table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply.

Location

string

M

1

Contains the URI of the newly created resource, according to the structure: {apiRoot}/nsmf-event-exposure/v1/subscriptions/{subId}

apiRoot

string

See clause 5.1

subId

string

Identifies a subscription to the SMF event exposure service formatted as defined for the SubId type in table 5.6.3.2-1.

n/a

n/a

NsmfEventExposure

M

1

200 OK

A representation of the SMF Notification Subscription matching the subId is returned.

RedirectResponse

O

0..1

307 Temporary Redirect

Temporary redirection, during Individual SMF Notification Subscription retrieval. The response shall include a Location header field containing an alternative URI of the resource located in an alternative SMF (service) instance.

Applicable if the feature "ES3XX" is supported.

RedirectResponse

O

0..1

308 Permanent Redirect

Permanent redirection, during Individual SMF Notification Subscription retrieval. The response shall include a Location header field containing an alternative URI of the resource located in an alternative SMF (service) instance.

Applicable if the feature "ES3XX" is supported..

NOTE: The mandatory HTTP error status codes for the GET method listed in table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply.

Location

string

M

1

An alternative URI of the resource located in an alternative SMF (service) instance.

3gpp-Sbi-Target-Nf-Id

string

O

0..1

Identifier of the target NF (service) instance towards which the request is redirected

Location

string

M

1

An alternative URI of the resource located in an alternative SMF (service) instance.

3gpp-Sbi-Target-Nf-Id

string

O

0..1

Identifier of the target NF (service) instance towards which the request is redirected

n/a

NsmfEventExposure

M

1

Modify the existing Individual SMF Notification Subscription resource matching the subId according to the representation in the NsmfEventExposure

NsmfEventExposure

M

1

200 OK

Successful case: The Individual SMF Notification Subscription resource matching the subId was modified and a representation is returned.

n/a

204 No Content

Successful case: The Individual SMF Notification Subscription resource matching the subId was modified.

RedirectResponse

O

0..1

307 Temporary Redirect

Temporary redirection, during Individual SMF Notification Subscription modification. The response shall include a Location header field containing an alternative URI of the resource located in an alternative SMF (service) instance.

Applicable if the feature "ES3XX" is supported.

RedirectResponse

O

0..1

308 Permanent Redirect

Permanent redirection, during Individual SMF Notification Subscription modification. The response shall include a Location header field containing an alternative URI of the resource located in an alternative SMF (service) instance.

Applicable if the feature "ES3XX" is supported..

NOTE: The mandatory HTTP error status codes for the PUT method listed in table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply.

Location

string

M

1

An alternative URI of the resource located in an alternative SMF (service) instance.

3gpp-Sbi-Target-Nf-Id

string

O

0..1

Identifier of the target NF (service) instance towards which the request is redirected

Location

string

M

1

An alternative URI of the resource located in an alternative SMF (service) instance.

3gpp-Sbi-Target-Nf-Id

string

O

0..1

Identifier of the target NF (service) instance towards which the request is redirected

n/a

n/a

n/a

204 No Content

Successful case: The Individual SMF Notification Subscription resource matching the subId was deleted.

RedirectResponse

O

0..1

307 Temporary Redirect

Temporary redirection, during Individual SMF Notification Subscription deletion. The response shall include a Location header field containing an alternative URI of the resource located in an alternative SMF (service) instance.

Applicable if the feature "ES3XX" is supported.

RedirectResponse

O

0..1

308 Permanent Redirect

Permanent redirection, during Individual SMF Notification Subscription deletion. The response shall include a Location header field containing an alternative URI of the resource located in an alternative SMF (service) instance.

Applicable if the feature "ES3XX" is supported..

NOTE: The manadatory HTTP error status code for the DELETE method listed in table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply.

Location

string

M

1

An alternative URI of the resource located in an alternative SMF (service) instance.

3gpp-Sbi-Target-Nf-Id

string

O

0..1

Identifier of the target NF (service) instance towards which the request is redirected

Location

string

M

1

An alternative URI of the resource located in an alternative SMF (service) instance.

3gpp-Sbi-Target-Nf-Id

string

O

0..1

Identifier of the target NF (service) instance towards which the request is redirected

Event Notification

{notifUri}

POST

Provides information about observed events.

Acknowledgement of event notification

{ackUri}

POST

Provides acknowledgement of event notification

notifUri

Uri

The Notification Uri as assigned either within the Individual SMF Notification Subscription Resource during the explicit subscription service operation and described within the NsmfEventExposure type (see table 5.6.2.2-1) or assigned during the implicit subscription via the provisioning of the subscription information within the PCC Rule from the PCF (see 3GPP TS 29.512 [14].

n/a

NsmfEventExposureNotification

M

1

Provides Information about observed events

n/a

204 No Content

The receipt of the Notification is acknowledged.

RedirectResponse

O

0..1

307 Temporary Redirect

Temporary redirection, during the event notification. The response shall include a Location header field containing an alternative URI representing the end point of an alternative NF consumer (service) instance where the acknowledgement request should be sent. Applicable if the feature "ES3XX" is supported.

RedirectResponse

O

0..1

308 Permanent Redirect

Permanent redirection, during the event notification. The response shall include a Location header field containing an alternative URI representing the end point of an alternative NF consumer (service) instance where the notification should be sent.

Applicable if the feature "ES3XX" is supported.

ProblemDetails

O

0..1

404 Not Found

The NF service consumer can use this response when the notification can be sent to another host.

NOTE: The mandatory HTTP error status codes for the POST method listed in table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply.

Location

string

M

1

An alternative URI representing the end point of an alternative NF consumer (service) instance towards which the notification should be redirected.

3gpp-Sbi-Target-Nf-Id

string

O

0..1

Identifier of the target NF (service) instance towards which the notification request is redirected. May be included if the feature "ES3XX" is supported.

Location

string

M

1

An alternative URI representing the end point of an alternative NF consumer (service) instance towards which the notification should be redirected.

3gpp-Sbi-Target-Nf-Id

string

O

0..1

Identifier of the target NF (service) instance towards which the notification request is redirected

ackUri

Uri

Acknowledgement Uri as assigned during the procedure of notification about subscribed events and described within the NsmfEventExposureNotification data type (see table 5.6.2.3-1).

n/a

AckOfNotify

M

1

Acknowledgement information of event notification

n/a

204 No Content

The receipt of the acknowledgement is successful.

RedirectResponse

O

0..1

307 Temporary Redirect

Temporary redirection, during acknowledgement of notification. The response shall include a Location header field containing an alternative URI representing the end point of an alternative SMF (service) instance where the acknowledgement request should be sent.

Applicable if the feature "ES3XX" is supported.

RedirectResponse

O

0..1

308 Permanent Redirect

Permanent redirection, during acknowledgement of notification. The response shall include a Location header field containing an alternative URI representing the end point of an alternative SMF (service) instance where the acknowledgement request should be sent.

Applicable if the feature "ES3XX" is supported.

NOTE: The mandatory HTTP error status codes for the POST method listed in table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply.

Location

string

M

1

An alternative URI representing the end point of an alternative SMF (service) instance towards which the acknowledgement should be redirected.

3gpp-Sbi-Target-Nf-Id

string

O

0..1

Identifier of the target NF (service) instance towards which the acknowledgement request is redirected

Location

string

M

1

An alternative URI representing the end point of an alternative SMF (service) instance towards which the acknowledgement should be redirected.

3gpp-Sbi-Target-Nf-Id

string

O

0..1

Identifier of the target NF (service) instance towards which the acknowledgement request is redirected

AckOfNotify

5.6.2.7

Acknowledgement information of event notification

AppliedSmccType

5.6.3.6

The type of applied SM congestion control.

SMCCE

EventNotification

5.6.2.5

Describes notifications about a single event that occurred.

EventSubscription

5.6.2.4

Represents the subscription to a single event

NotificationMethod

5.6.3.4

Represents the notification methods that can be subscribed

NsmfEventExposure

5.6.2.2

Represents an Individual SMF Notification Subscription resource

NsmfEventExposureNotification

5.6.2.3

Describes Notifications about events that occurred.

PduSessionInfo

5.6.2.12

Represents session information.

UeCommunication

PduSessionInformation

5.6.2.11

Represents the PDU session related information.

UeCommunication

PduSessionStatus

5.6.3.8

Status of the PDU Session.

UeCommunication

SmfEvent

5.6.3.3

Represents the types of events that can be subscribed

SubId

5.6.3.2

Identifies an Individual SMF Notification Subscription.

SmNasFromSmf

5.6.2.9

Describes the information of the SM NAS messages from SMF with backoff timer

SMCCE

SmNasFromUe

5.6.2.8

Describes the information of the SM NAS requests from UE

SMCCE

TransactionInfo

5.6.2.10

UE Session Management transaction information.

Dispersion

TransactionMetric

5.6.3.7

Metric on UE Session Management transactions.

Dispersion

UpfInformation

5.6.2.13

The information of the UPF serving the UE.

ServiceExperience

DnPerformance

AccessType

3GPP TS 29.571 [11]

AfResultInfo

3GPP TS 29.522 [20]

Represents application handling information.

ApplicationId

3GPP TS 29.571 [11]

The application identifier.

QfiAllocation

CommunicationFailure

3GPP TS 29.518 [13]

Represents the communication failure information.

CommunicationFailure

DateTime

3GPP TS 29.571 [11]

DlDataDeliveryStatus

3GPP TS 29.571 [11]

Status of downlink data delivery

DownlinkDataDeliveryStatus

DddTrafficDescriptor

3GPP TS 29.571 [11]

Traffic descriptor of source of downlink data

DownlinkDataDeliveryStatus

Dnai

3GPP TS 29.571 [11]

DnaiChangeType

3GPP TS 29.571 [11]

Describes the types of DNAI change.

Dnn

3GPP TS 29.571 [11]

QfiAllocation, PduSessionStatus

DurationSec

3GPP TS 29.571 [11]

EthFlowDescription

3GPP TS 29.514 [22]

Ethernet flow description

QfiAllocation

FlowDescription

3GPP TS 29.514 [22]

IP flow description

QfiAllocation

Fqdn

3GPP TS 29.571 [11]

FQDN

Gpsi

3GPP TS 29.571 [11]

GroupId

3GPP TS 29.571 [11]

Guami

3GPP TS 29.571 [11]

Globally Unique AMF Identifier

IpAddr

3GPP TS 29.571 [11]

UE IP address.

Dispersion

Ipv4Addr

3GPP TS 29.571 [11]

Ipv6Addr

3GPP TS 29.571 [11]

Ipv6Prefix

3GPP TS 29.571 [11]

MacAddr48

3GPP TS 29.571 [11]

MAC Address.

NotificationFlag

3GPP TS 29.571 [11]

Notification flag.

EneNA

PartitioningCriteria

3GPP TS 29.571 [11]

Used to partition UEs before applying sampling.

EneNA

PduSessionId

3GPP TS 29.571 [11]

PduSessionType

3GPP TS 29.571 [11]

PDU session type.

PduSessionStatus

PlmnIdNid

3GPP TS 29.571 [11]

Identification of a network: the PLMN Identifier or the SNPN Identifier (the PLMN Identifier and the NID).

ProblemDetails

3GPP TS 29.571 [11]

Qfi

3GPP TS 29.571 [11]

QoS flow identifier.

QfiAllocation

RatType

3GPP TS 29.571 [11]

RedirectResponse

3GPP TS 29.571 [11]

Contains redirection related information.

ES3XX

RouteToLocation

3GPP TS 29.571 [11]

A traffic route to/from an DNAI

SamplingRatio

3GPP TS 29.571 [11]

Sampling Ratio.

ServiceName

3GPP TS 29.510 [12]

Name of the service instance.

Snssai

3GPP TS 29.571 [11]

S-NSSAI

QfiAllocation

Supi

3GPP TS 29.571 [11]

SupportedFeatures

3GPP TS 29.571 [11]

Used to negotiate the applicability of the optional features defined in table 5.8-1.

TimeWindow

3GPP TS 29.122 [24]

A start time and a stop time of a time window.

SMCCE

Uinteger

3GPP TS 29.571 [11]

Uri

3GPP TS 29.571 [11]

supi

Supi

C

0..1

Subscription Permanent Identifier (NOTE  1)

gpsi

Gpsi

C

0..1

Generic Public Subscription Identifier (NOTE  1)

This IE is not applicable to "SMCC_EXP" event.

anyUeInd

boolean

C

0..1

This IE shall be present if the event subscription is applicable to any UE. Default value "false" is used, if not present (NOTE 1) (NOTE 4)

groupId

GroupId

C

0..1

Identifies a group of UEs. (NOTE 1)

pduSeId

PduSessionId

C

0..1

PDU session ID (NOTE 1)

dnn

Dnn

O

0..1

Data Network Name.

snssai

Snssai

O

0..1

A single Network Slice Selection Assistance Information. (NOTE 4)

subId

SubId

C

0..1

Subscription ID.
This parameter shall be supplied by the SMF in HTTP responses that include an object of NsmfEventExposure type.

notifId

string

M

1

Notification Correlation ID provided by the NF service consumer. (NOTE 2)

notifUri

Uri

M

1

Identifies the recipient of Notifications sent by the SMF.

altNotifIpv4Addrs

array(Ipv4Addr)

O

1..N

Alternate or backup IPv4 Address(es) where to send Notifications.

altNotifIpv6Addrs

array(Ipv6Addr)

O

1..N

Alternate or backup IPv6 Address(es) where to send Notifications.

altNotifFqdns

array(Fqdn)

O

1..N

Alternate or backup FQDN(s) where to send Notifications.

eventSubs

array(EventSubscription)

M

1..N

Subscribed events. (NOTE 4)

eventNotifs

array(EventNotification)

O

1..N

Represents the SMF Events to be reported in the Nsmf_EvenExposure_Subscribe response.

May be present when the "ERIR" feature is supported and the "ImmeRep" attribute set to true is included in the subscription request.

ERIR

ImmeRep

boolean

O

0..1

It is included and set to true if the immediate reporting of the current status of the subscribed event, if available is required.

notifMethod

NotificationMethod

O

0..1

If "notifMethod" is not supplied, the default value "ON_EVENT_DETECTION" applies. (NOTE 4)

maxReportNbr

Uinteger

O

0..1

If omitted, there is no limit. (NOTE 4)

expiry

DateTime

C

0..1

This attribute indicates the expiry time of the subscription, after which the SMF shall not send any event notifications and the subscription becomes invalid. It may be included in an event subscription request and may be included in an event subscription response based on operator policies. If an expiry time was included in the request, then the expiry time returned in the response should be less than or equal to that value. If the expiry time is not included in the response, the NF service consumer shall not associate an expiry time for the subscription. (NOTE 4)

repPeriod

DurationSec

C

0..1

Is supplied for notification Method "periodic".

guami

Guami

C

0..1

The Globally Unique AMF Identifier (GUAMI) shall be provided by an AMF as NF service consumer.

serviceName

ServiceName

O

0..1

If the NF service consumer is an AMF, it should provide the name of a service produced by the AMF that makes use of the notification about subscribed events.

supportedFeatures

SupportedFeatures

C

0..1

List of Supported features used as described in clause 5.8.

This parameter shall be supplied by NF service consumer and SMF in the POST request that request the creation of an SMF Notification Subscriptions resource and the related reply, respectively.

sampRatio

SamplingRatio

O

0..1

Indicates the ratio of the random subset to target UEs, event reports only relates to the subset.

partitionCriteria

array(PartitioningCriteria)

O

1..N

Defines criteria for partitioning the UEs in order to apply the sampling ratio for each partition. It may only be included in event subscription requests when the "sampRatio" attribute is also provided. (NOTE 3)

EneNA

grpRepTime

DurationSec

O

0..1

Indicates the time for which the SMF aggregates the event reports detected by the UEs in a group and report them together to the NF service consumer.

notifFlag

NotificationFlag

O

0..1

Indicates the notification flag, which is used to mute/unmute notifications and to retrieve events stored during a period of muted notifications.

Default: "ACTIVATE"

EneNA

NOTE 1: If the event subscription applies for a specific PDU session, the PDU session of a single UE (pduSeId, and gpsi/supi) shall be included; otherwise one and only one of a single UE (gpsi/supi), a group of UEs (groupId), or anyUeInd set to true shall be included.

NOTE 2: If the UDM as NF service consumer subscribes to event (e.g. downlink data delivery status, PDU Session Establishment, PDU Session Release) on behalf of AF/NEF, "notifId" shall be set the same as "referenceId" received from the AF/NEF as defined in clause 6.4.6.2.4 of 3GPP TS 29.503 [14].

NOTE 3: For a given type of partitioning criteria, the UE shall belong to only one single partition as long as it is served by the NF service producer.

NOTE 4: If EneNA feature is supported, when the "snssai" attribute is presented together with "anyUeInd" attribute and the "eventSubs" attribute contains "PDU_SES_EST" and "PDU_SES_REL", then only the "ON_EVENT_DETECTION" value is applicable in the "notifMethod" attribute together with "maxReportNbr" attribute and/or "expiry"attribute presence.

notifId

string

M

1

Notification correlation ID used to identify the subscription which the notification is corresponding to. It shall be set to the same value as the "notifId" attribute of NsmfEventExposure data type or the value of "notifCorreId" within the UpPathChgEvent data type defined in 3GPP TS 29.512 [14] or the value of "notifCorreId" within the QosMonitoringData data type defined in 3GPP TS 29.512 [14].

eventNotifs

array(EventNotification)

M

1..N

Notifications about Individual Events

ackUri

Uri

O

0..1

The URI provided by the SMF for the AF acknowledgement.

If present, it only applies to the "UP_PATH_CH" event indicated in the "eventNotifs" attribute.

event

SmfEvent

M

1

Subscribed events

dnaiChgType

DnaiChangeType

C

0..1

For event UP path change, this attribute indicates whether the subscription is for early, late, or early and late DNAI change notification shall be supplied.

dddTraDescriptors

array(DddTrafficDescriptor)

C

1..N

The traffic descriptor(s) of the downlink data source. Shall be included for event "DDDS".

DownlinkDataDeliveryStatus

dddStati

array(DlDataDeliveryStatus)

O

1..N

May be included for event "DDDS". The subscribed statuses (discarded, transmitted, buffered) for the event. If omitted all statuses are subscribed.

DownlinkDataDeliveryStatus

appIds

array(ApplicationId)

O

1..N

May be included for event "QFI_ALLOC" or "DISPERSION".

QfiAllocation

Dispersion

targetPeriod

TimeWindow

O

0..1

Indicates the data collection target period.

May be included for event "RED_TRANS_EXP", "SMCC_EXP", "RED_TRANS_EXP" or "WLAN_INFO".

SMCCE

RedundantTransmissionExp

WlanPerformance

transacDispInd

boolean

O

0..1

Indicates the subscription for UE transaction dispersion collection, if it is included and set to "true". Default value is "false".

May be included for event "DISPERSION".

Dispersion

transacMetrics

array(TransactionMetric)

O

1..N

Requested transaction metrics.

May be included for event "DISPERSION".

Dispersion

ueIpAddr

IpAddr

O

0..1

Indicates the UE IP address. May be included for event "DISPERSION".

Dispersion

event

SmfEvent

M

1

Event that is notified.

timeStamp

DateTime

M

1

Time at which the event is observed.

supi

Supi

C

0..1

Subscription Permanent Identifier. It is included when the subscription applies to a group of UE(s) or any UE.

gpsi

Gpsi

C

0..1

Identifies a GPSI. It shall contain an MSISDN. It is included when it is available and the subscription applies to a group of UE(s) or any UE.

This IE is not applicable to "SMCC_EXP" event.

ueIpAddr

IpAddr

C

0..1

Indicates the UE IP address, It is included for event "DISPERSION" when it is available and requested in the subscription.

Dispersion

transacInfos

array(TransactionInfo)

C

1..N

Transaction Information.

Dispersion

sourceDnai

Dnai

C

0..1

Source DN Access Identifier. Shall be included for event "UP_PATH_CH" if the DNAI changed (NOTE 1, NOTE 2).

targetDnai

Dnai

C

0..1

Target DN Access Identifier. Shall be included for event "UP_PATH_CH" if the DNAI changed (NOTE 1, NOTE 2).

dnaiChgType

DnaiChangeType

C

0..1

DNAI Change Type. Shall be included for event "UP_PATH_CH".

sourceUeIpv4Addr

Ipv4Addr

O

0..1

The IPv4 Address of the served UE for the source DNAI. May be included for event "UP_PATH_CH".

sourceUeIpv6Prefix

Ipv6Prefix

O

0..1

The Ipv6 Address Prefix of the served UE for the source DNAI. May be included for event "UP_PATH_CH".

targetUeIpv4Addr

Ipv4Addr

O

0..1

The IPv4 Address of the served UE for the target DNAI. May be included for event "UP_PATH_CH".

targetUeIpv6Prefix

Ipv6Prefix

O

0..1

The Ipv6 Address Prefix of the served UE for the target DNAI. May be included for event "UP_PATH_CH".

sourceTraRouting

RouteToLocation

C

0..1

N6 traffic routing information for the source DNAI. Shall be included for event "UP_PATH_CH" if available (NOTE 2).

targetTraRouting

RouteToLocation

C

0..1

N6 traffic routing information for the target DNAI. Shall be included for event "UP_PATH_CH" if available (NOTE 2).

ueMac

MacAddr48

O

0..1

UE MAC address. May be included for event "UP_PATH_CH".

adIpv4Addr

Ipv4Addr

O

0..1

Added IPv4 Address(es). May be included for event "UE_IP_CH".

adIpv6Prefix

Ipv6Prefix

O

0..1

Added Ipv6 Address Prefix(es). May be included for event "UE_IP_CH".

reIpv4Addr

Ipv4Addr

O

0..1

Removed IPv4 Address(es). May be included for event "UE_IP_CH".

reIpv6Prefix

Ipv6Prefix

O

0..1

Removed Ipv6 Address Prefix(es). May be included for event "UE_IP_CH".

plmnId

PlmnIdNid

C

0..1

New PLMN Identifier or the SNPN Identifier. Shall be included for event "PLMN_CH".

(NOTE 7)

accType

AccessType

C

0..1

New Access Type. Shall be included for event "AC_TY_CH".

pduSeId

PduSessionId

C

0..1

PDU session ID. Shall be included for event "PDU_SES_REL" and "PDU_SES_EST". It shall also be included for event "QFI_ALLOC" if the subscription was for a UE, a group of UEs, or any UE, and not for a specific PDU Session.

ratType

RatType

C

0..1

New RAT Type. Shall be included for event ‘RAT_TY_CH’.

EneNA

dddStatus

DlDataDeliveryStatus

C

0..1

Downlink data delivery status (discarded, transmitted, buffered). Shall be included for event "downlink data delivery status",

DownlinkDataDeliveryStatus

maxWaitTime

DateTime

C

0..1

The estimated maximum waiting time for downlink data delivery, Shall be included for event "downlink data delivery status" with status "BUFFERED".

DownlinkDataDeliveryStatus

dddTraDescriptor

DddTrafficDescriptor

C

0..1

The downlink data descriptor impacted by downlink data delivery status change. Shall be included for event "downlink data delivery status"

DownlinkDataDeliveryStatus

commFailure

CommunicationFailure

C

0..1

Describes the communication failure cause for the UE. Shall be included for event "COMM_FAIL".

CommunicationFailure

ipv4Addr

Ipv4Addr

O

0..1

IPv4 address. May be included for event "PDU_SES_REL" or "PDU_SES_EST".

PduSessionStatus

ipv6Prefixes

array(Ipv6Prefix)

O

1..N

IPv6 prefixes. May be included for event "PDU_SES_REL" or "PDU_SES_EST". (NOTE 3)

PduSessionStatus

ipv6Addrs

array(Ipv6Addr)

O

1..N

IPv6 addresses. May be included for event "PDU_SES_REL" or "PDU_SES_EST". (NOTE 3)

PduSessionStatus

pduSessType

PduSessionType

C

0..1

PDU session type. Shall be included if the PduSessionStatus feature is supported.

PduSessionStatus

qfi

Qfi

C

0..1

QoS flow identifier. Shall be included for event "QFI_ALLOC".

QfiAllocation

appId

ApplicationId

O

0..1

Contains the application identifier. May be included for event "QFI_ALLOC". (NOTE 4)

QfiAllocation

ethFlowDescs

array(EthFlowDescription)

O

1..N

Descriptor(s) for non-IP traffic in which only ethernet flow description is defined. It allows the encoding of multiple UL and/or DL flows. Each entry of the array describes a single Ethernet flow. May be included for event "QFI_ALLOC", when the description of the Ethernet traffic requires multiple UL and/or DL flows. (NOTE 4)

MultipleFlowDescriptions

ethfDescs

array(EthFlowDescription)

O

1..2

Contains the flow description for the Uplink and/or Downlink Ethernet flows. May be included for event "QFI_ALLOC". (NOTE 4)

QfiAllocation

flowDescs

array(FlowDescription)

O

1..N

Descriptor(s) of IP traffic. It allows the encoding of multiple UL and/or DL flows. Each entry of the array describes a single IP flow. May be included for event "QFI_ALLOC", when the description of the IP traffic requires multiple UL and/or DL flows. (NOTE 4)

MultipleFlowDescriptions

fDescs

array(FlowDescription)

O

1..2

Contains the flow description for the Uplink and/or Downlink IP flows. May be included for event "QFI_ALLOC". (NOTE 4)

QfiAllocation

dnn

Dnn

C

0..1

Data network name, Shall be included for event "QFI_ALLOC". May be included for event "PDU_SES_REL" or "PDU_SES_EST". Shall be included to indiate the DNN associated with URLLC service for event "RED_TRANS_EXP".

Shall be included if DNN based SMCC is applied.

QfiAllocation, PduSessionStatus

RedundantTransmissionExp

SMCCE

snssai

Snssai

C

0..1

Identifies the slice information. Shall be included for event "QFI_ALLOC".

Shall be included if S-NSSAI based SMCC is applied.

QfiAllocation

EneNA

SMCCE

ulDelays

array(Uinteger)

O

1..N

Uplink packet delay in units of milliseconds. May be included for event "QOS_MON". (NOTE 5)

QoSMonitoring

dlDelays

array(Uinteger)

O

1..N

Downlink packet delay in units of milliseconds. May be included for event "QOS_MON". (NOTE 5)

QoSMonitoring

rtDelays

array(Uinteger)

O

1..N

Round trip delay in units of milliseconds. May be included for event "QOS_MON". (NOTE 5)

QoSMonitoring

timeWindow

TimeWindow

C

0..1

Time window representing a start time and a stop time of the data collection period. Shall be included for event "SMCC_EXP".

SMCCE

smNasFromUe

array(SmNasFromUe)

C

1..N

Information on the SM NAS messages that SMF receives from UE for PDU Session. Shall be included for event "SMCC_EXP".

SMCCE

smNasFromSmf

array(SmNasFromSmf)

C

1..N

Information on the SM congestion control applied SM NAS messages that SMF sends to UE for PDU Session. Shall be included for event "SMCC_EXP".

SMCCE

upRedTrans

boolean

C

0..1

Indicates whether the redundant transmission is setup or terminated. Set to "true" if the redundant transmission is setup, otherwise set to "false" if the redundant transmission is terminated. Default value is set to "false". Shall be included for event "RED_TRANS_EXP".

RedundantTransmissionExp

ssId

string

C

0..1

SSID that the PDU session is related to. (NOTE 6)

WlanPerformance

bssId

string

C

0..1

BSSID that the PDU session is related to. (NOTE 6)

WlanPerformance

startWlan

DateTime

C

0..1

The time stamp that indicates when the existing PDU Session’s access type changes to WLAN or when the new PDU Session for WLAN is established. (NOTE 6)

WlanPerformance

endWlan

DateTime

C

0..1

The time stamp that indicates when the existing WLAN based PDU Session’s access type is not WLAN any more or when the PDU Session for WLAN is released. (NOTE 6)

WlanPerformance

pduSessInfos

array(PduSessionInformation)

C

1..N

The PDU session related information. It shall be included for event "UP_STATUS_INFO".

UeCommunication

upfInfo

UpfInformation

C

0..1

The information of the UPF serving the UE.

Shall be included for event "UPF_INFO".

ServiceExperience

DnPerformance

NOTE 1: If the DNAI is not changed while the N6 traffic routing information is changed, the "sourceDnai" attribute and "targetDnai" attribute shall not be provided.

NOTE 2: The change from the UP path status where no DNAI applies to a status where a DNAI applies indicates the activation of the related AF request and therefore only the target DNAI and N6 traffic routing information is provided in the event notification; the change from the UP path status where a DNAI applies to a status where no DNAI applies indicates the de-activation of the related AF request and therefore only the source DNAI and N6 traffic routing information is provided in the event notification.

NOTE 3: If provided, either ipv6Prefixes or ipv6Addrs shall be present.

NOTE 4: Only one of the appId, ethfDescs, ethFlowDescs, flowDescs or fDescs attributes shall be provided.

NOTE 5: In this release of the specification the maximum number of elements in the array is 2. If more than one value is received at one given point of time for UL packet delay, DL packet delay or round trip packet delay respectively, the SMF reports the minimum and maximum packet delays to the NEF/AF.

NOTE 6: If notified event is "WLAN_INFO", then one of the "ssId" or "bssId" attribute and one of the "startWLAN" or "endWLAN" attribute shall be present.

NOTE 7: The SNPN Identifier consists of the PLMN Identifier and the NID.

notifId

string

M

1

Notification correlation ID provided by the SMF during UP path change notification.

ackResult

AfResultInfo

M

1

Identifies the result of application layer handling.

supi

Supi

O

0..1

Subscription Permanent Identifier.

gpsi

Gpsi

O

0..1

Identifies a GPSI.

smNasType

string

M

1

The type of SM NAS message transmitted by UE (e.g. PDU Session Establishment Request, PDU Session Modification Request, etc.).

timeStamp

DateTime

M

1

Indicates the time stamp when SMF receives SM NAS message from UE.

smNasType

string

M

1

The type of SM NAS message with backoff timer provided to UE (e.g. PDU Session Establishment Reject, PDU Session Modification Reject, PDU Session Release Command, etc.).

timeStamp

DateTime

M

1

Indicates the time stamp when SMF sends SM NAS message to UE.

backOffTimer

DurationSec

M

1

Indicates the value of backoff timer provided to UE in terms of time units of seconds.

appliedSmccType

AppliedSmccType

M

1

The type of applied SM congestion control, i.e. DNN based congestion control or S-NSSAI based congestion control.

transaction

Uinteger

M

1

Number of transactions.

snssai

Snssai

C

0..1

Identifier of the network slice.

appIds

array(ApplicationId)

O

1..N

Application Identifiers.

transMetrics

array(TransactionMetric)

O

1..N

Indicates Session Management Transaction metrics.

pduSessId

PduSessionId

C

0..1

Identification of PDU Session. It shall be provided if available.

sessInfo

PduSessionInfo

C

0..1

Represents session information. It shall be provided if available.

n4SessId

string

C

0..1

Identification of N4 Session. It shall be provided if available.

sessInactiveTimer

DurationSec

C

0..1

The value of the session inactivity timer. It shall be provided if available.

pduSessStatus

PduSessionStatus

C

0..1

Status of the PDU Session. It shall be provided if available.

upfId

string

C

0..1

Identifies the UPF.

(NOTE 1) (NOTE 2)

upfAddr

AddrFqdn

C

0..1

Represents the IP address/FQDN of the UPF.

(NOTE 1) (NOTE 2)

NOTE 1: At least one of the "upfId" attribute and "upfAddr" attribute shall be included.

NOTE 2: The "upfId" attribute and "upfAddr" attribute may indicate an anchor UPF of the PDU session containing the QoS flow.

SubId

string

Identifies an Individual SMF Notification Subscription. To enable that the value is used as part of a URI, the string shall only contain characters allowed according to the "lower-with-hyphen" naming convention defined in 3GPP TS 29.501 [5]. In an OpenAPI [10] schema, the format shall be designated as "SubId".

AC_TY_CH

Access Type Change

UP_PATH_CH

UP Path Change

PDU_SES_REL

PDU Session Release

PLMN_CH

PLMN Change

UE_IP_CH

UE IP address change

RAT_TY_CH

RAT Type Change

EneNA

DDDS

Downlink data delivery status

DownlinkDataDeliveryStatus

COMM_FAIL

Communication failure

CommunicationFailure

PDU_SES_EST

PDU Session Establishment

PduSessionStatus

QFI_ALLOC

QFI allocation

QfiAllocation

QOS_MON

QoS Monitoring

QoSMonitoring

SMCC_EXP

SM congestion control experience for PDU Session

SMCCE

DISPERSION

Session Management transaction dispersion

Dispersion

RED_TRANS_EXP

Redundant transmission experience for PDU Session

RedundantTransmissionExp

WLAN_INFO

WLAN information on PDU session for which Access Type is NON_3GPP_ACCESS and RAT Type is TRUSTED_WLAN

WlanPerformance

UPF_INFO

The UPF information, including the UPF ID/address/FQDN information.

ServiceExperience

DnPerformance

UP_STATUS_INFO

User Plane status information

UeCommunication

PERIODIC

The notification is periodically sent.

ONE_TIME

The notification is only sent one time.

ON_EVENT_DETECTION

The notification is sent each time the event is detected.

DNN_CC

Indicates the DNN based congestion control.

SNSSAI_CC

Indicates the S-NSSAI based congestion control.

PDU_SES_EST

PDU Session Establishment

PDU_SES_AUTH

PDU Session Authenication

PDU_SES_MODIF

PDU Session Modification

PDU_SES_REL

PDU Session Release

ACTIVATED

Indicates the pdu session status is activated.

DEACTIVATED

Indicates the pdu session status is deactivated.

1

DownlinkDataDeliveryStatus

This feature indicates support for the "Downlink data delivery status" event.

2

CommunicationFailure

This feature indicates support for the "communication failure" event.

3

PduSessionStatus

This feature indicates support for the PDU session establishment event and enhancement (PDU session type, IP address) for the PDU session release event.

4

QfiAllocation

This feature indicates support for the "QFI allocation" event.

5

QosMonitoring

This feature indicates support for the "QoS Monitoring" event.

6

ES3XX

Extended Support for 3xx redirections. This feature indicates the support of redirection for any service operation, according to Stateless NF procedures as specified in clauses 6.5.3.2 and 6.5.3.3 of 3GPP TS 29.500 [4] and according to HTTP redirection principles for indirect communication, as specified in clause 6.10.9 of 3GPP TS 29.500 [4].

7

EneNA

This feature indicates support for the enhancements of network data analytics requirements.

8

ULBuffering

This feature indicates support for Uplink buffering indication. (See NOTE)

9

SMCCE

This feature indicates support for Session Management Congestion Control Experience for PDU Session.

10

Dispersion

This feature indicates support for Session Management transactions dispersion.

11

ERIR

Indicates the support of immediate report within the subscription response.

12

RedundantTransmissionExp

This feature indicates support for Redundant Transmission Experience.

13

WlanPerformance

This feature indicates support for WLAN information on PDU Session for which Access Type is NON_3GPP_ACCESS and RAT Type is TRUSTED_WLAN, to support WLAN performance analytics.

14

EASIPreplacement

This feature indicates the support of provisioning of EAS IP replacement info (See NOTE).

15

BIUMR

This feature bit indicates whether the NF Service Consumer (e.g. SMF) and PCF supports Binding Indication Update for multiple resource contexts specified in clauses 6.12.1 and 5.2.3.2.6 of 3GPP TS 29.500 [4].

16

UeCommunication

This feature indicates the support of UE communication analytics.

17

ServiceExperience

This feature indicates support for service experience analytics.

18

DnPerformance

This feature indicates support for DN performance analytics.

19

MultipleFlowDescriptions

This feature indicates the support of the report of multiple UL and/or DL flows.

NOTE: SMF and NF service consumers determine the support of this feature via the Nnrf_NFDiscovery service operation as defined in 3GPP TS 29.510 [12].