6.2 Namf_EventExposure Service API
29.5183GPP5G SystemAccess and Mobility Management ServicesRelease 18Stage 3TS
6.2.1 API URI
The Namf_EventExposure shall use the Namf_EventExposure API.
The API URI of the Namf_EventExposure API shall be:
{apiRoot}/<apiName>/<apiVersion>/
The request URI used in HTTP requests from the NF service consumer towards the NF service producer shall have the Resource URI structure defined in clause 4.4.1 of 3GPP TS 29.501 [5], i.e.:
{apiRoot}/<apiName>/<apiVersion>/<apiSpecificResourceUriPart>
with the following components:
– The {apiRoot} shall be set as described in 3GPP TS 29.501 [5].
– The <apiName> shall be "namf-evts".
– The <apiVersion> shall be "v1".
– The <apiSpecificResourceUriPart> shall be set as described in clause 6.2.3.
6.2.2 Usage of HTTP
6.2.2.1 General
HTTP/2, as defined in IETF RFC 7540 [19], shall be used as specified in clause 5 of 3GPP TS 29.500 [4].
HTTP/2 shall be transported as specified in clause 5.3 of 3GPP TS 29.500 [4].
HTTP messages and bodies for the Namf_EventExposure service shall comply with the OpenAPI [23] specification contained in Annex A.
6.2.2.2 HTTP standard headers
6.2.2.2.1 General
The usage of HTTP standard headers shall be supported as specified in clause 5.2.2 of 3GPP TS 29.500 [4].
6.2.2.2.2 Content type
The following content types shall be supported:
– JSON, as defined in IETF RFC 8259 [8], shall be used as content type of the HTTP bodies specified in the present specification as indicated in clause 5.4 of 3GPP TS 29.500 [4].
– The Problem Details JSON Object (IETF RFC 7807 [36]). The use of the Problem Details JSON object in a HTTP response body shall be signalled by the content type "application/problem+json".
– JSON Patch (IETF RFC 6902 [14]). The use of the JSON Patch format in a HTTP request body shall be signalled by the content type "application/json-patch+json".
6.2.2.3 HTTP custom headers
6.2.2.3.1 General
In this release of this specification, no custom headers specific to the Namf_EventExposure service are defined. For 3GPP specific HTTP custom headers used across all service based interfaces, see clause 5.2.3 of 3GPP TS 29.500 [4].
6.2.3 Resources
6.2.3.1 Overview
Figure 6.2.3.1-1: Resource URI structure of the Namf_EventExposure API
Table 6.2.3.1-1 provides an overview of the resources and applicable HTTP methods.
Table 6.2.3.1-1: Resources and methods overview
Resource name |
Resource URI |
HTTP method or custom operation |
Description |
Subscriptions collection |
/subscriptions |
POST |
Mapped to the service operation Subscribe, when to create a subscription |
Individual subscription |
/{subscriptionId} |
PATCH |
Mapped to the service operation Subscribe, when to modify |
DELETE |
Mapped to the service operation Unsubscribe |
6.2.3.2 Resource: Subscriptions collection
6.2.3.2.1 Description
This resource represents a collection of subscriptions created by NF service consumers of Namf_EventExposure service.
This resource is modelled as the Collection resource archetype (see clause C.2 of 3GPP TS 29.501 [5]).
6.2.3.2.2 Resource Definition
Resource URI: {apiRoot}/namf-evts/<apiVersion>/subscriptions
This resource shall support the resource URI variables defined in table 6.2.3.2.2-1.
Table 6.2.3.2.2-1: Resource URI variables for this resource
Name |
Data type |
Definition |
apiRoot |
string |
See clause 6.2.1 |
apiVersion |
string |
See clause 6.2.1. |
6.2.3.2.3 Resource Standard Methods
6.2.3.2.3.1 POST
This method shall support the URI query parameters specified in table 6.2.3.2.3.1-1.
Table 6.2.3.2.3.1-1: URI query parameters supported by the POST method on this resource
Name |
Data type |
P |
Cardinality |
Description |
n/a |
This method shall support the request data structures specified in table 6.2.3.2.3.1-2 and the response data structures and response codes specified in table 6.2.3.2.3.1-3.
Table 6.2.3.2.3.1-2: Data structures supported by the POST Request Body on this resource
Data type |
P |
Cardinality |
Description |
AmfCreateEventSubscription |
M |
1 |
Describes of an AMF Event Subscription to be created |
Table 6.2.3.2.3.1-3: Data structures supported by the POST Response Body on this resource
Data type |
P |
Cardinality |
Response codes |
Description |
AmfCreatedEventSubscription |
M |
1 |
201 Created |
Represents successful creation of an AMF Event Subscription |
RedirectResponse |
O |
0..1 |
307 Temporary Redirect |
Temporary redirection. The response shall include a Location header field containing a different URI, or the same URI if a request is redirected to the same target resource via a different SCP. In the former case, the URI shall be an alternative URI of the resource located on an alternative service instance within the same AMF or AMF (service) set. |
RedirectResponse |
O |
0..1 |
308 Permanent Redirect |
Permanent redirection. The response shall include a Location header field containing a different URI, or the same URI if a request is redirected to the same target resource via a different SCP. In the former case, the URI shall be an alternative URI of the resource located on an alternative service instance within the same AMF or AMF (service) set. |
ProblemDetails |
O |
0..1 |
403 Forbidden |
Indicates the creation of subscription has failed due to application error. The "cause" attribute may be used to indicate one of the following application errors: – UE_NOT_SERVED_BY_AMF |
NOTE: The mandatory HTTP error status code for the POST method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply, with response body containing an object of ProblemDetails data type (see clause 5.2.7 of 3GPP TS 29.500 [4]). |
Table 6.2.3.2.3.1-4: Headers supported by the 201 Response Code on this resource
Name |
Data type |
P |
Cardinality |
Description |
Location |
string |
M |
1 |
Contains the URI of the newly created resource, according to the structure: {apiRoot}/namf-evts/<apiVersion>/subscriptions/{subscriptionId} |
Table 6.2.3.2.3.1-5: Headers supported by the 307 Response Code on this resource
Name |
Data type |
P |
Cardinality |
Description |
Location |
string |
M |
1 |
An alternative URI of the resource located on an alternative service instance within the same AMF or AMF (service) set. Or the same URI, if a request is redirected to the same target resource via a different SCP. |
3gpp-Sbi-Target-Nf-Id |
string |
O |
0..1 |
Identifier of the target NF (service) instance ID towards which the request is redirected |
Table 6.2.3.2.3.1-6: Headers supported by the 308 Response Code on this resource
Name |
Data type |
P |
Cardinality |
Description |
Location |
string |
M |
1 |
An alternative URI of the resource located on an alternative service instance within the same AMF or AMF (service) set. Or the same URI, if a request is redirected to the same target resource via a different SCP. |
3gpp-Sbi-Target-Nf-Id |
string |
O |
0..1 |
Identifier of the target NF (service) instance ID towards which the request is redirected |
6.2.3.2.4 Resource Custom Operations
None.
6.2.3.3 Resource: Individual subscription
6.2.3.3.1 Description
This resource represents an individual of subscription created by NF service consumers of Namf_EventExposure service.
This resource is modelled as the Document resource archetype (see clause C.1 of 3GPP TS 29.501 [5]).
6.2.3.3.2 Resource Definition
Resource URI: {apiRoot}/namf-evts/<apiVersion>/subscriptions/{subscriptionId}
This resource shall support the resource URI variables defined in table 6.2.3.3.2-1.
Table 6.2.3.3.2-1: Resource URI variables for this resource
Name |
Data type |
Definition |
apiRoot |
string |
See clause 6.2.1 |
apiVersion |
string |
See clause 6.2.1. |
subscriptionId |
string |
String identifies an individual subscription to the AMF event exposure service |
6.2.3.3.3 Resource Standard Methods
6.2.3.3.3.1 PATCH
This method shall support the URI query parameters specified in table 6.2.3.3.3.1-1.
Table 6.2.3.3.3.1-1: URI query parameters supported by the PATCH method on this resource
Name |
Data type |
P |
Cardinality |
Description |
n/a |
This method shall support the request data structures specified in table 6.2.3.3.3.1-2 and the response data structures and response codes specified in table 6.2.3.3.3.1-3.
Table 6.2.3.3.3.1-2: Data structures supported by the PATCH Request Body on this resource
Data type |
P |
Cardinality |
Description |
array(AmfUpdateEventSubscriptionItem) |
M |
1..N |
Document describes the modification(s) to a AMF Event Subscription |
array(AmfUpdateEventOptionItem) |
M |
1..1 |
Document describing the modification to the event subscription options (e.g subscription expiry time). |
Table 6.2.3.3.3.1-3: Data structures supported by the PATCH Response Body on this resource
Data type |
P |
Cardinality |
Response codes |
Description |
AmfUpdatedEventSubscription |
M |
1 |
200 OK |
Represents a successful update on AMF Event Subscription |
RedirectResponse |
O |
0..1 |
307 Temporary Redirect |
Temporary redirection. The response shall include a Location header field containing a different URI, or the same URI if a request is redirected to the same target resource via a different SCP. In the former case, the URI shall be an alternative URI of the resource located on an alternative service instance within the same AMF or AMF (service) set. |
RedirectResponse |
O |
0..1 |
308 Permanent Redirect |
Permanent redirection. The response shall include a Location header field containing a different URI, or the same URI if a request is redirected to the same target resource via a different SCP. In the former case, the URI shall be an alternative URI of the resource located on an alternative service instance within the same AMF or AMF (service) set. |
ProblemDetails |
O |
0..1 |
403 Forbidden |
Indicates the modification of subscription has failed due to application error. The "cause" attribute may be used to indicate one of the following application errors: – UE_NOT_SERVED_BY_AMF |
ProblemDetails |
O |
0..1 |
404 Not Found |
Indicates the modification of subscription has failed due to application error. The "cause" attribute may be used to indicate one of the following application errors: – SUBSCRIPTION_NOT_FOUND |
NOTE: The mandatory HTTP error status code for the PATCH method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply, with response body containing an object of ProblemDetails data type (see clause 5.2.7 of 3GPP TS 29.500 [4]). |
Table 6.2.3.3.3.1-4: Headers supported by the 307 Response Code on this resource
Name |
Data type |
P |
Cardinality |
Description |
Location |
string |
M |
1 |
An alternative URI of the resource located on an alternative service instance within the same AMF or AMF (service) set. Or the same URI, if a request is redirected to the same target resource via a different SCP. |
3gpp-Sbi-Target-Nf-Id |
string |
O |
0..1 |
Identifier of the target NF (service) instance ID towards which the request is redirected |
Table 6.2.3.3.3.1-5: Headers supported by the 308 Response Code on this resource
Name |
Data type |
P |
Cardinality |
Description |
Location |
string |
M |
1 |
An alternative URI of the resource located on an alternative service instance within the same AMF or AMF (service) set. Or the same URI, if a request is redirected to the same target resource via a different SCP. |
3gpp-Sbi-Target-Nf-Id |
string |
O |
0..1 |
Identifier of the target NF (service) instance ID towards which the request is redirected |
6.2.3.3.3.2 DELETE
This method shall support the URI query parameters specified in table 6.2.3.3.3.2-1.
Table 6.2.3.3.3.2-1: URI query parameters supported by the DELETE method on this resource
Name |
Data type |
P |
Cardinality |
Description |
n/a |
This method shall support the request data structures specified in table 6.2.3.3.3.2-2 and the response data structures and response codes specified in table 6.2.3.3.3.2-3.
Table 6.2.3.3.3.2-2: Data structures supported by the DELETE Request Body on this resource
Data type |
P |
Cardinality |
Description |
n/a |
Table 6.2.3.3.3.2-3: Data structures supported by the DELETE Response Body on this resource
Data type |
P |
Cardinality |
Response codes |
Description |
n/a |
204 No Content |
|||
RedirectResponse |
O |
0..1 |
307 Temporary Redirect |
Temporary redirection. The response shall include a Location header field containing a different URI, or the same URI if a request is redirected to the same target resource via a different SCP. In the former case, the URI shall be an alternative URI of the resource located on an alternative service instance within the same AMF or AMF (service) set. |
RedirectResponse |
O |
0..1 |
308 Permanent Redirect |
Permanent redirection. The response shall include a Location header field containing a different URI, or the same URI if a request is redirected to the same target resource via a different SCP. In the former case, the URI shall be an alternative URI of the resource located on an alternative service instance within the same AMF or AMF (service) set. |
ProblemDetails |
O |
0..1 |
404 Not Found |
Indicates the modification of subscription has failed due to application error. The "cause" attribute may be used to indicate one of the following application errors: – SUBSCRIPTION_NOT_FOUND. |
NOTE: The mandatory HTTP error status code for the DELETE method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply, with response body containing an object of ProblemDetails data type (see clause 5.2.7 of 3GPP TS 29.500 [4]). |
Table 6.2.3.3.3.2-4: Headers supported by the 307 Response Code on this resource
Name |
Data type |
P |
Cardinality |
Description |
Location |
string |
M |
1 |
An alternative URI of the resource located on an alternative service instance within the same AMF or AMF (service) set. Or the same URI, if a request is redirected to the same target resource via a different SCP. |
3gpp-Sbi-Target-Nf-Id |
string |
O |
0..1 |
Identifier of the target NF (service) instance ID towards which the request is redirected |
Table 6.2.3.3.3.2-5: Headers supported by the 308 Response Code on this resource
Name |
Data type |
P |
Cardinality |
Description |
Location |
string |
M |
1 |
An alternative URI of the resource located on an alternative service instance within the same AMF or AMF (service) set. Or the same URI, if a request is redirected to the same target resource via a different SCP. |
3gpp-Sbi-Target-Nf-Id |
string |
O |
0..1 |
Identifier of the target NF (service) instance ID towards which the request is redirected |
6.2.3.3.4 Resource Custom Operations
None.
6.2.4 Custom Operations without associated resources
There are no custom operations without associated resources supported on Namf_EventExposure Service.
6.2.5 Notifications
6.2.5.1 Void
This clause specifies the notifications provided by the Namf_EventExposure service.
Table 6.2.5.1-1: Notifications overview
Notification |
Callback URI |
HTTP method or custom operation |
Description (service operation) |
AMF Event Notification |
{eventNotifyUri} |
POST |
|
AMF Event Notification |
{subsChangeNotifyUri} |
POST |
6.2.5.2 AMF Event Notification
If a NF service consumer has subscribed to an event(s) supported by Namf_EventExposure service, when AMF aware of a state change of the event, AMF shall create a notification including the event state report, and shall deliver the notification to the call-back URI, following Subscribe/Notify mechanism defined in 3GPP TS 29.501 [5].
6.2.5.2.1 Notification Definition
Call-back URI: {callbackUri}
Call-back URI is provided by NF Service Consumer during creation of the subscription. If the notification is to inform the change of subscription ID and if the "subsChangeNotifyUri" was provided in the AmfEventSubscription, then this callback URI shall be the "subsChangeNotifyUri" provided in the AmfEventSubscription. Otherwise, this callback URI shall be the "eventNotifyUri" provided in the AmfEventSubscription.
6.2.5.2.3 Notification Standard Methods
6.2.5.2.3.1 POST
This method shall support the request data structures specified in table 6.2.5.2.3.1-1 and the response data structures and response codes specified in table 6.2.5.2.3.1-2.
Table 6.2.5.2.3.1-2: Data structures supported by the POST Request Body
Data type |
P |
Cardinality |
Description |
AmfEventNotification |
M |
1 |
Represents the notification to be delivered |
Table 6.2.5.2.3.1-3: Data structures supported by the POST Response Body
Data type |
P |
Cardinality |
Response codes |
Description |
n/a |
204 No Content |
|||
RedirectResponse |
O |
0..1 |
307 Temporary Redirect |
Temporary redirection. The NF service consumer shall generate a Location header field containing a URI pointing to the endpoint of another NF service consumer to which the notification should be sent. If an SCP redirects the message to another SCP then the location header field shall contain the same URI or a different URI pointing to the endpoint of the NF service consumer to which the notification should be sent. |
RedirectResponse |
O |
0..1 |
308 Permanent Redirect |
Permanent redirection. The NF service consumer shall generate a Location header field containing a URI pointing to the endpoint of another NF service consumer to which the notification should be sent. If an SCP redirects the message to another SCP then the location header field shall contain the same URI or a different URI pointing to the endpoint of the NF service consumer to which the notification should be sent. |
NOTE: The mandatory HTTP error status code for the POST method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply, with response body containing an object of ProblemDetails data type (see clause 5.2.7 of 3GPP TS 29.500 [4]). |
Table 6.2.5.2.3.1-4: Headers supported by the 307 Response Code on this resource
Name |
Data type |
P |
Cardinality |
Description |
Location |
string |
M |
1 |
A URI pointing to the endpoint of the NF service consumer to which the notification should be sent |
3gpp-Sbi-Target-Nf-Id |
string |
O |
0..1 |
Identifier of the target NF (service) instance ID towards which the request is redirected |
Table 6.2.5.2.3.1-5: Headers supported by the 308 Response Code on this resource
Name |
Data type |
P |
Cardinality |
Description |
Location |
string |
M |
1 |
A URI pointing to the endpoint of the NF service consumer to which the notification should be sent |
3gpp-Sbi-Target-Nf-Id |
string |
O |
0..1 |
Identifier of the target NF (service) instance ID towards which the request is redirected |
6.2.6 Data Model
6.2.6.1 General
This clause specifies the application data model supported by the API.
Table 6.2.6.1-1 specifies the data types defined for the Namf_EventExposure service based interface protocol.
Table 6.2.6.1-1: Namf_EventExposure specific Data Types
Data type |
Clause defined |
Description |
AmfEventSubscription |
6.2.6.2.2 |
Represents an individual event subscription resource on AMF |
AmfEvent |
6.2.6.2.3 |
Describes an event to be subscribed |
AmfEventNotification |
6.2.6.2.4 |
Data within an AMF Event Notification request. |
AmfEventReport |
6.2.6.2.5 |
Represents a report triggered by a subscribed event type |
AmfEventMode |
6.2.6.2.6 |
Describes how the reports shall be generated by a subscribed event |
AmfEventState |
6.2.6.2.7 |
Represents the state of a subscribed event |
RmInfo |
6.2.6.2.8 |
Represents the registration state of a UE for an access type |
CmInfo |
6.2.6.2.9 |
Represents the connection management state of a UE for an access type |
CommunicationFailure |
6.2.6.2.11 |
Describes a communication failure detected by AMF |
AmfCreateEventSubscription |
6.2.6.2.12 |
Data within a create AMF event subscription request |
AmfCreatedEventSubscription |
6.2.6.2.13 |
Data within a create AMF event subscription response |
AmfUpdateEventSubscriptionItem |
6.2.6.2.14 |
Document describing the modification(s) to an AMF Event Subscription |
AmfUpdatedEventSubscription |
6.2.6.2.15 |
Represents a successful update on an AMF Event Subscription |
AmfEventArea |
6.2.6.2.16 |
Represents an area to be monitored by an AMF event. |
LadnInfo |
6.2.6.2.17 |
LADN Information |
AmfUpdateEventOptionItem |
6.2.6.2.18 |
Document describing the modifications to AMF event subscription options. |
5GsUserStateInfo |
6.2.6.2.19 |
Represents the 5GS User state of the UE for an access type |
TrafficDescriptor |
6.2.6.2.20 |
Represents the Traffic Descriptor |
UEIdExt |
6.2.6.2.21 |
UE Identity |
AmfEventSubsSyncInfo |
6.2.6.2.22 |
AMF Event Subscriptions Information for synchronization |
AmfEventSubscriptionInfo |
6.2.6.2.23 |
Individual AMF Event Subscription Information |
TargetArea |
6.2.6.2.24 |
TA list or TAI range list or any TA |
SnssaiTaiMapping |
6.2.6.2.25 |
List of restricted or unrestricted S-NSSAIs per TAI(s) |
SupportedSnssai |
6.2.6.2.26 |
Supported S-NSSAIs |
UeInAreaFilter |
6.2.6.2.27 |
Describe the filter related to UEs In Area Report event. |
IdleStatusIndication |
6.2.6.2.28 |
Represents the idle status indication. |
UeAccessBehaviorReportItem |
6.2.6.2.29 |
Report Item for UE Access Behavior Trends event. |
UeLocationTrendsReportItem |
6.2.6.2.30 |
Report Item for UE Location Trends event. |
DispersionArea |
6.2.6.2.31 |
Dispersion Area |
MmTransactionLocationReportItem |
6.2.6.2.32 |
UE MM Transaction Report Item per Location |
MmTransactionSliceReportItem |
6.2.6.2.33 |
UE MM Transaction Report Item per Slice |
AmfEventType |
6.2.6.3.3 |
Describes the supported event types of Namf_EventExposure Service |
AmfEventTrigger |
6.2.6.3.4 |
Describes how AMF should generate the report for the event |
LocationFilter |
6.2.6.3.5 |
Describes the supported filters of LOCATION_REPORT event type |
UeReachability |
6.2.6.3.7 |
Describes the reachability of the UE |
RmState |
6.2.6.3.9 |
Describes the registration management state of a UE |
CmState |
6.2.6.3.10 |
Describes the connection management state of a UE |
5GsUserState |
6.2.6.3.11 |
Describes the 5GS User State of a UE |
LossOfConnectivityReason |
6.2.6.3.12 |
Describes the reason for loss of connectivity |
ReachabilityFilter |
6.2.6.3.13 |
Event filter for REACHABILITY_REPORT event type. |
UeType |
6.2.6.3.14 |
Describe UE type |
AccessStateTransitionType |
6.2.6.3.15 |
Access State Transition Type |
SubTerminationReason |
6.2.6.3.16 |
Subscription Termination Reason |
Table 6.2.6.1-2 specifies data types re-used by the Namf_EventExposure service based interface protocol from other specifications, including a reference to their respective specifications and when needed, a short description of their use within the Namf_EventExposure service based interface.
Table 6.2.6.1-2: Namf_EventExposure re-used Data Types
Data type |
Reference |
Comments |
Supi |
3GPP TS 29.571 [6] |
|
GroupId |
3GPP TS 29.571 [6] |
|
DurationSec |
3GPP TS 29.571 [6] |
|
Gpsi |
3GPP TS 29.571 [6] |
|
Uri |
3GPP TS 29.571 [6] |
|
Pei |
3GPP TS 29.571 [6] |
|
UserLocation |
3GPP TS 29.571 [6] |
|
TaI |
3GPP TS 29.571 [6] |
|
TimeZone |
3GPP TS 29.571 [6] |
|
AccessType |
3GPP TS 29.571 [6] |
|
Ecgi |
3GPP TS 29.571 [6] |
EUTRA Cell Identifier |
Ncgi |
3GPP TS 29.571 [6] |
NR Cell Identifier |
NfInstanceId |
3GPP TS 29.571 [6] |
|
ProblemDetails |
3GPP TS 29.571 [6] |
Problem Details |
SupportedFeatures |
3GPP TS 29.571 [6] |
Supported Features |
DateTime |
3GPP TS 29.571 [6] |
|
NgApCause |
3GPP TS 29.571 [6] |
|
PresenceInfo |
3GPP TS 29.571 [6] |
Presence Reporting Area Information |
PresenceState |
3GPP TS 29.571 [6] |
Describes the presence state of the UE to a specified area of interest |
Dnn |
3GPP TS 29.571 [6] |
|
Snssai |
3GPP TS 29.571 [6] |
|
DddTrafficDescriptor |
3GPP TS 29.571 [6] |
Downlink Data Delivery Traffic Descriptor |
SamplingRatio |
3GPP TS 29.571 [6] |
Sampling Ratio. |
RedirectResponse |
3GPP TS 29.571 [6] |
Response body of the redirect response message. |
NotificationFlag |
3GPP TS 29.571 [6] |
Notification flag |
ExtSnssai |
3GPP TS 29.571 [6] |
|
N3gaLocation |
3GPP TS 29.571 [6] |
Non-3GPP Location |
ReferenceId |
3GPP TS 29.503 [35] |
|
NsiId |
3GPP TS 29.531 [18] |
NSI ID |
NFType |
3GPP TS 29.510 [29] |
NF type |
TaiRange |
3GPP TS 29.510 [29] |
6.2.6.2 Structured data types
6.2.6.2.1 Introduction
Structured data types used in Namf_EventExposure service are specified in this clause.
6.2.6.2.2 Type: AmfEventSubscription
Table 6.2.6.2.2-1: Definition of type AmfEventSubscription
Attribute name |
Data type |
P |
Cardinality |
Description |
Applicability |
eventList |
array(AmfEvent) |
M |
1..N |
Describes the events to be subscribed in subscription request or the events successfully subscribed for this subscription in subscription response. |
|
eventNotifyUri |
Uri |
M |
1 |
Identifies the recipient of notifications sent by AMF for this subscription (NOTE 1) |
|
notifyCorrelationId |
string |
M |
1 |
Identifies the notification correlation ID. The AMF shall include this ID in the notifications. The value of this IE shall be unique per subscription for a given NF service consumer. |
|
nfId |
NfInstanceId |
M |
1 |
Indicates the instance identity of the network function creating the subscription. |
|
subsChangeNotifyUri |
Uri |
C |
0..1 |
This IE shall be present if the subscription is created by an NF service consumer on behalf of another NF (e.g UDM creating event subscription at AMF for event notifications towards NEF). When present, this IE Identifies the recipient of notifications sent by AMF, for the creation of a new subscription ID, that is considered as a change of subscription ID by the NF service consumer for event subscriptions related to single UE or as the creation of a new subscription Id for event subscriptions related to UE groups (e.g during mobility procedures involving AMF change). (NOTE 3). |
|
subsChangeNotifyCorelationId |
string |
C |
0..1 |
This IE shall be present when an NF Service Consumer (e.g. UDM) is subscribing for events on behalf of another NF Service Consumer (e.g. NEF). When present, this IE shall contain the notification correlation ID. The AMF shall include it in the notifications for the creation of a new subcription ID that is considered as a change of subscription ID by the NF service consumer for event subscriptions related to single UE or as the creation of a new subscription Id for event subscriptions related to UE groups. The value of this IE shall be unique per subscription for a given NF service consumer that is sending this IE. (NOTE 3).. |
|
supi |
Supi |
C |
0..1 |
Subscription Permanent Identifier (NOTE 2) |
|
groupId |
GroupId |
C |
0..1 |
Identifies a group of UEs. (NOTE 2) |
|
excludeSupiList |
array(Supi) |
O |
1..N |
This IE may be present for a group subscription. When present, this IE shall carry the SUPI of the group member UE(s) that are excluded from the group subscription. |
DGEM |
excludeGpsiList |
array(Gpsi) |
O |
1..N |
This IE may be present for a group subscription. When present, this IE shall carry the GPSI of the group member UE(s) that are excluded from the group subscription. |
DGEM |
includeSupiList |
array(Supi) |
O |
1..N |
This IE may be present for a group subscription. When present, this IE shall carry the SUPI of the group member UE(s) that are included for the group subscription. |
DGEM |
includeGpsiList |
array(Gpsi) |
O |
1..N |
This IE may be present for a group subscription. When present, this IE shall carry the GPSI of the group member UE(s) that are included for the group subscription. |
DGEM |
gpsi |
Gpsi |
C |
0..1 |
Generic Public Subscription Identifier (NOTE 2) |
|
pei |
Pei |
C |
0..1 |
Permanent Equipment Identifier (NOTE 2) |
|
anyUE |
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. The attribute shall be set to "TRUE", when the AMF event type is "SNSSAI_TA_MAPPING_REPORT". (NOTE 2) |
|
options |
AmfEventMode |
O |
0..1 |
This IE may be included if the NF service consumer wants to describe how the reports of the event have to be generated. The absence of this IE, when creating an AMF event subscription or when transferring the UE context to another AMF, shall be interpreted as a "ONE_TIME" AMF event trigger. |
|
sourceNfType |
NFType |
C |
0..1 |
This IE should be present for a subscription that is created by an "intermediate NF" (e.g. UDM) on behalf of a "source NF" (e.g. NEF). When present, it shall contain the NF type of the "source NF". |
|
termNotifyInd |
boolean |
O |
0..1 |
When present this IE shall indicate whether the notification of event subscription termination from the AMF is requested by the NF consumer. – true: Event subscription termination notification requested – false (default) Event subscription termination notification not requested |
STEN |
NOTE 1: When an NF Service Consumer subscribes on behalf of another NF, the Notification URI identifies a resource under the authority of the other NF. NOTE 2: Either information about a single UE (i.e. SUPI, GPSI, PEI) or groupId, or anyUE set to "TRUE" shall be included. NOTE 3: Same values of "subsChangeNotifyUri" and "subsChangeNotifyCorrelationId" shall be provided by an NF service consumer to all the serving AMF if the subscriptions apply to a group and triggered by one subscription from another NF. This allows the NF service consumer to associate the subscription Id creation notifications received from different serving AMFs to the same group Id subscription, |
6.2.6.2.3 Type: AmfEvent
Table 6.2.6.2.3-1: Definition of type AmfEvent
Attribute name |
Data type |
P |
Cardinality |
Description |
Applicability |
type |
AmfEventType |
M |
1 |
Describes the AMF event type to be reported |
|
immediateFlag |
boolean |
O |
0..1 |
Indicates if an immediate event report containing the currently available value / status of the event is requested. The report contains the value / status of the event currently available at the AMF at the time of the subscription (NOTE 1). If the flag is not present then immediate reporting shall not be done and the first report is sent at event detection time. When the subscribing NF subscribes on behalf of another NF, the IERSR feature controls whether or not an immediate report is sent within the subscribe response message or within a notification request message (see clause 5.3.2.2.2). Otherwise immediate reports are always sent within the subscribe response message. The default value is false. |
|
areaList |
array(AmfEventArea) |
O |
1..N |
Identifies the area to be applied. More than one instance of AmfEventArea IE shall be used only when the AmfEventArea is provided during event subscription for Presence Reporting Area subscription. |
|
locationFilterList |
array(LocationFilter) |
O |
1..N |
Describes the filters to be applied for LOCATION_REPORT event type. If this attribute is not present in the request, it indicates the change of the TA used by the UE should be reported. |
|
refId |
ReferenceId |
O |
0..1 |
Indicates the Reference Id associated with the event. (NOTE 3) |
|
trafficDescriptorList |
array(TrafficDescriptor) |
O |
1..N |
Indicates the filters to be applied for AVAILABILITY_AFTER_DDN_FAILURE event type. |
|
reportUeReachable |
boolean |
C |
0..1 |
This IE shall be present and set to value "true" by the source AMF to request the target AMF to notify the subscriber when UE becomes reachable, during inter-AMF mobility procedures. When present, this IE shall be set as following: – true: target AMF shall notify the subscriber when UE becomes reachable – false (default): target AMF shall not notify the subscriber when UE becomes reachable, until next reporting trigger is detected, i.e. DDN failure detected (for AVAILABILITY_AFTER_DDN_FAILURE event) or UE becomes unreachable for downlink traffic (for "UE Reachable for DL Traffic" of REACHABILITY_REPORT event) This IE only applies to following Event Types: – AVAILABILITY_AFTER_DDN_FAILURE – REACHABILITY_REPORT (for "UE Reachable for DL Traffic") |
|
reachabilityFilter |
ReachabilityFilter |
O |
0..1 |
When present, this IE shall indicate the filter to be applied for the REACHABILITY_REPORT event type. If the subscription of REACHABILITY_REPORT is for "UE Reachability Status Change", the AMF shall report current reachability state and subsequent updated reachability state of the UE, when AMF becomes aware of a UE reachability state change between REACHABLE, UNREACHABLE and REGULATORY_ONLY. If the subscription of REACHABILITY_REPORT is for "UE Reachable for DL Traffic", the AMF shall report the "REACHABLE" state, when the UE transitions to CM-CONNECTED mode or when the UE will become reachable for paging, as specified in table 4.15.3.1-1, clauses 4.2.5 and 4.3.3 of 3GPP TS 23.502 [3]. If this IE is absent, the subscription of REACHABILITY_REPORT is for "UE Reachability Status Change". |
|
udmDetectInd |
boolean |
O |
0..1 |
The IE may be present for subscription for "UE Reachable for DL Traffic". When present, this IE shall indicate whether the UE Reachability Event will be detected at UDM (i.e. with Nudm_UECM_Registration) or not: – true: UE Reachability will be detected at UDM – false (default) UE Reachability will not be detected at UDM |
|
maxReports |
integer |
O |
0..1 |
This IE may be present if the trigger is set to "CONTINUOUS" or "PERIODIC". When present, this IE describes the maximum number of reports that can be generated by the subscribed event. If the AMF event subscription is for a group of UEs, this parameter shall be applied to each individual member UE of the group. If the event subscription is transferred from source AMF to a target AMF, this IE shall contain: – the remaining number of reports for the event subscription, in the case of individual UE event subscription; or – the remaining number of reports for the event subscription for this specific UE, in the case of a group event subscription. If the group subscription has not expired and all reports have been sent already for this event, the remaining number of reports shall be set to "0". (NOTE 2) |
|
presenceInfoList |
map(PresenceInfo) |
O |
1..N |
Map of PRA Information, the "praId" attribute within the PresenceInfo data type shall also be the key of the map. The "presenceState" attribute within the PresenceInfo data type shall not be supplied. When present, the areaList shall be absent. |
MPRA |
maxResponseTime |
DurationSec |
C |
0..1 |
This IE shall be present, when the UDM subscribes to "REACHABILITY_REPORT" event for "UE Reachable for DL Traffic" on behalf of the AF and the AF sets the Maximum Response Time in the Monitoring Configuration. When present, this IE shall indicate the Maximum Response Time configured by the AF. |
|
targetArea |
TargetArea |
C |
0..1 |
The IE shall be present for subscription for SNSSAI_TA_MAPPING_REPORT event type. When present, this IE shall indicate the TAI list to be applied. |
|
snssaiFilter |
array(ExtSnssai) |
O |
1..N |
The IE may be present for subscription for SNSSAI_TA_MAPPING_REPORT event type. This IE shall be present for subscription of UE_MM_TRANSACTION_REPORT event to receive the UE Mobility Management Transaction numbers based on slices. When present, this IE shall indicate the S-NSSAI list to be applied. (NOTE 4) |
|
ueInAreaFilter |
UeInAreaFilter |
O |
0..1 |
Indicates the filter to be applied for UES_IN_AREA_REPORT event type related to UAVs. When present, this IE shall indicate the list of items to be applied together as filter. |
UARF |
minInterval |
DurationSec |
O |
0..1 |
This IE may be present when the NF consumer subscribes to "REACHABILITY_REPORT" event for "UE Reachable for DL Traffic". When present, this IE indicates the minimal interval to report the event, i.e. when an event is reported, a subsequent event report shall not be sent during the interval. |
|
nextReport |
DateTime |
O |
0..1 |
This IE may be present when the event subscription is transferred from source AMF to a target AMF and minInterval is configured for this event. When present, this IE shall indicate the time point before when a subsequent event report shall be throttled. |
|
idleStatusInd |
boolean |
O |
0..1 |
Idle Status Indication request. May be present if type is REACHABILITY_REPORT or AVAILABILITY_AFTER_DDN_FAILURE true: Idle status indication is requested false (default): Idle status indication is not requested |
|
dispersionArea |
DispersionArea |
C |
0..1 |
This IE shall be present for subscription to the UE_MM_TRANSACTION_REPORT event to receive the UE Mobility Management Transaction numbers based on location, or for subscription to the UE_LOCATION_TRENDS event. When present, this IE indicates the target area where the related events to be reported for dispersion analytics. (NOTE x) |
|
nextPeriodicReportTime |
DateTime |
C |
0..1 |
This IE should be present when the event subscription is transferred from source AMF to a target AMF and there are periodic report(s) to be generated for the event. When present, this IE shall indicate the timestamp when the next periodic report for the event to be generated and notified to the NF consumer. |
|
NOTE 1: The requested value of the location is the last known location (i.e. age of location may be greater than zero) if the immediate Flag is set to true. An NF Service Consumer requesting to receive the current location (i.e. age of location equal to zero) shall not set the immediateFlag to true when subscribing to a location event report. NOTE 2: When creating an AMF event subscription with multiple events, the same maximum number of reports shall apply to each event. Accordingly, maxReports in this attribute should not be present when creating an AMF event subscription; if it is present, it shall contain the same value for all events and maxReports in the AmfEventMode shall have precedence over the maxReports in this attribute. maxReports in this attribute and maxReports in the AmfEventMode have different semantics when transferring the event subscription from a source AMF to a target AMF. NOTE 3: Each Monitoring Configuration subscribed via UDM Event Exposure service uses a Reference Id as the key. This IE shall carry the Reference Id when UDM subscribes to the AMF event for the corresponding Monitoring Configuration. NOTE 4: For a subscription to the UE_MM_TRANSACTION_REPORT event, either the snssaiFilter IE or the dispersionArea shall be present. The AMF shall report the UE MM Transaction numbers based on slices or location according to the presence of the IE. |
6.2.6.2.4 Type: AmfEventNotification
Table 6.2.6.2.4-1: Definition of type AmfEventNotification
Attribute name |
Data type |
P |
Cardinality |
Description |
Applicability |
notifyCorrelationId |
string |
C |
0..1 |
This IE shall be included if the notification is not for informing creation of a new subscription Id. This IE shall also be included if the notification is for informing the creation of a new subscription Id and the corresponding event subscription did not contain subsChangeNotifyCorrelationId attribute (see clause 6.2.6.2.2). When present, this IE shall indicate the notification correlation Id provided by the NF service consumer during event subscription. This parameter can be useful if the NF service consumer uses a common call-back URI for multiple subscriptions. |
|
subsChangeNotifyCorrelationId |
string |
C |
0..1 |
This IE shall be included if the notification is for informing the creation of a new subscription Id at the AMF and the corresponding event subscription contains the subsChangeNotifyCorrelationId attribute (see clause 6.2.6.2.2). When present, this IE shall be set to the value of the subsChangeNotifyCorrelationId provided during subscription (see clause 6.2.6.2.2). |
|
reportList |
array(AmfEventReport) |
C |
1..N |
This IE shall be present if a event is reported. When present, this IE represents the event reports to be delivered. |
|
eventSubsSyncInfo |
AmfEventSubsSyncInfo |
C |
0..1 |
This IE may be present for AMF to initiate event subscription synchronization with UDM during UE mobility procedures. When present, this IE shall contain the information for event subscription synchronization, including all active event subscriptions specificially targeting the UE. |
ESSYNC |
6.2.6.2.5 Type: AmfEventReport
Table 6.2.6.2.5-1: Definition of type AmfEventReport
Attribute name |
Data type |
P |
Cardinality |
Description |
Applicability |
type |
AmfEventType |
M |
1 |
Describes the type of the event which triggers the report |
|
state |
AmfEventState |
M |
1 |
Describes the state of the event which triggered the report. This IE shall be set to "TRUE" when subscriptionId IE is present. |
|
timeStamp |
DateTime |
M |
1 |
This IE shall contain the time at which the event is generated. |
|
subscriptionId |
Uri |
C |
0..1 |
This IE shall be included when the event notification is for informing the creation of a subscription Id at the AMF during mobility of a UE across AMFs. When present, this IE shall contain the URI of the created subscription resource at the AMF; this shall contain an absolute URI set to the Resource URI specified in clause 6.2.3.3.2. The type IE shall be set to: – SUBSCRIPTION_ID_CHANGE, when the AMFcreates a subscription Id for a UE specific event subscription during mobility registration and handover procedures involving an AMF change. – SUBSCRIPTION_ID_ADDITION, when the AMF creates a subscription Id for a group Id specific event subscription during mobility registration and handover procedures involving an AMF change. |
|
anyUe |
boolean |
C |
0..1 |
This IE shall be included and shall be set to "true", if the event subscription is a bulk subscription for number of UEs and the event reported is for one of those UEs. |
|
supi |
Supi |
C |
0..1 |
This IE shall be present if available. When present, this IE identifies the SUPI of the UE associated with the report (NOTE 1). |
|
areaList |
array(AmfEventArea) |
C |
1..N |
This IE shall be present when the AMF event type is "PRESENCE_IN_AOI_REPORT". When present, this IE represents the specified Area(s) of Interest the UE is currently IN / OUT / UNKNOWN. If the AMF event is subscribed towards a PRA identifier referring to a Set of Core Network predefined Presence Reporting Areas, the AMF shall report both the subscribed PRA Identifier and the additional PRA identifier of the actually individual PRA(s) where the UE is currently IN / OUT, as specified in clause 5.6.11 of 3GPP TS 23.501 [2]. |
|
refId |
ReferenceId |
C |
0..1 |
This IE shall be present if a Reference Id has previously been associated with the event triggering the report. When present, this IE shall indicate the Reference Id associated with the event which triggers the report. |
|
gpsi |
Gpsi |
C |
0..1 |
This IE shall be present if available. When present, this IE identifies the GPSI of the UE associated with the report (NOTE 1). |
|
pei |
Pei |
O |
0..1 |
This IE may be included if the event reported is for a particular UE or any UE. This IE identifies the PEI of the UE associated with the report (NOTE 1). |
|
location |
UserLocation |
O |
0..1 |
Represents the location information of the UE This IE shall convey exactly one of the following: – Non-3GPP access user location. If the additionalLocation IE is present, this IE shall contain either an E-UTRA user location or NR user location. |
|
additionalLocation |
UserLocation |
O |
0..1 |
This IE shall be present if the "location IE" is present and the AMF reports both a 3GPP user location and a non-3GPP access user location. When present, this IE shall convey the non-3GPP access user location. |
|
timezone |
TimeZone |
O |
0..1 |
Describes the time zone of the UE |
|
accessTypeList |
array(AccessType) |
O |
1..N |
Describes the access type(s) of the UE. When reporting that the UE is reachable for DL traffic, this IE shall indicate the access type(s) through which the UE is reachable. This attribute shall be absent if the AMF event type is "SNSSAI_TA_MAPPING_REPORT". |
|
rmInfoList |
array(RmInfo) |
O |
1..N |
Describes the registration management state of the UE |
|
cmInfoList |
array(CmInfo) |
O |
1..N |
Describes the connection management state of the UE |
|
reachability |
UeReachability |
O |
0..1 |
Describes the reachability of the UE |
|
commFailure |
CommunicationFailure |
O |
0..1 |
Describes a communication failure for the UE. |
|
numberOfUes |
integer |
O |
0..1 |
Represents the number of UEs in the specified area |
|
5gsUserStateList |
array(5GsUserStateInfo) |
O |
1..N |
Represents the 5GS User State of the UE per access type |
|
typeCode |
string |
C |
0..1 |
This IE shall be present when the AMF event type is "TYPE_ALLOCATION_CODE_REPORT". When present, this IE represents the Type Allocation code (TAC), to indicate terminal model and vendor information of the UE. Pattern: ‘^imeitac-[0-9]{8}$’. |
ENA |
registrationNumber |
integer |
C |
0..1 |
This IE shall be present when the AMF event type is "FREQUENT_MOBILITY_REGISTRATION_REPORT". When present, this IE represents the number of the mobility registration procedures during a period identified by the expiry time included in the event subscription request. |
ENA |
ueIdExtList |
array(UEIdExt) |
C |
1..N |
This IE shall be present if multiple SUPIs and / or GPSIs need to be included, the AMF event type is "UES_IN_AREA_REPORT" and the subscribing NF indicated support of the ENA feature. This attribute provides additional SUPIs and / or GPSIs to the supi attribute or gpsi attribute. The ueIdExt attribute may be present even if both the supi and gpsi attributes are absent. |
ENA |
lossOfConnectReason |
LossOfConnectivityReason |
O |
0..1 |
Describes the reason for loss of connectivity. This IE should be present when the AMF event type is "LOSS_OF_CONNECTIVITY". |
|
maxAvailabilityTime |
DateTime |
O |
0..1 |
Indicates the time (in UTC) until which the UE is expected to be reachable. This IE may be present in REACHABILITY_REPORT event report for "UE Reachable_for DL Traffic". This information may be used by the SMS Service Center to prioritize the retransmission of pending Mobile Terminated Short Message to UEs using a power saving mechanism (eDRX, PSM etc.). |
|
snssaiTaiList |
array(SnssaiTaiMapping) |
C |
1..N |
This IE shall be present when the AMF event type is "SNSSAI_TA_MAPPING_REPORT". When present, this IE represents the list of supported S-NSSAIs at the TAI(s). It shall also include the indication if S-NSSAI is restricted at the AMF. |
|
idleStatusIndication |
IdleStatusIndication |
O |
0..1 |
Idle Status Indication May be present when type is REACHABILITY_REPORT or AVAILABILITY_AFTER_DDN_FAILURE |
|
ueAccessBehaviorTrends |
array(UeAccessBehaviorReportItem) |
C |
1..N |
This IE shall be present to report "UE_ACCESS_BEHAVIOR_TRENDS" event. When present, this IE shall include the UE access behavior trends within the report period. |
|
ueLocationTrends |
array(UeLocationTrendsReportItem) |
C |
1..N |
This IE shall be present to report "UE_LOCATION_TRENDS" event. When present, this IE shall include the UE location trends within the report period. (NOTE 2) |
|
mmTransLocationReportList |
array(MmTransactionLocationReportItem) |
C |
1..N |
This IE shall be present to report "UE_MM_TRANSACTION_REPORT" event based on location. When present, this IE shall include the number of UE MM transactions per location within the report period. |
|
mmTransSliceReportList |
array(MmTransactionSliceReportItem) |
C |
1..N |
This IE shall be present to report "UE_MM_TRANSACTION_REPORT" event based on slices. When present, this IE shall include the number of UE MM transactions per slice within the report period. |
|
termReason |
SubTerminationReason |
O |
0..1 |
This IE may be present when the event type is SUBSCRIPTION_TERMINATION. When present, this IE shall indicate the reason for the subscription termination. |
|
NOTE 1: If the event report corresponds to an event subscription of a single UE, then the same UE identifier (i.e. SUPI and/or GPSI and/or PEI) received during subscription creation shall be included in the report. If the event report corresponds to an event subscription for group of UEs or any UE, then the SUPI and if available the GPSI shall be included in the event report. SUPI, PEI and GPSI shall not be present in report for UES_IN_AREA_REPORT event type. NOTE 2: The items shall be listed in descending order by the value of "duration" attribute. |
6.2.6.2.6 Type: AmfEventMode
Table 6.2.6.2.6-1: Definition of type AmfEventMode
Attribute name |
Data type |
P |
Cardinality |
Description |
Applicability |
trigger |
AmfEventTrigger |
M |
1 |
Describes how the reports are triggered. |
|
maxReports |
integer |
C |
0..1 |
This IE shall be present if the trigger is set to "CONTINUOUS" while "expiry" attribute is not present. This IE may be present if the trigger is set to "PERIODIC". When present, this IE describes the maximum number of reports that can be generated by each subscribed event in the subscription. If the AMF event subscription is for a list of events, this parameter shall be applied to each individual event in the list. If the AMF event subscription is for a group of UEs, this parameter shall be applied to each individual member UE of the group. If the event subscription is transferred from source AMF to target AMF, this IE shall contain: – the remaining number of reports for the event subscription, in the case of individual UE event subscription; – the maximum number of reports for each event of the AMF event subscription for each individual member of the group, in the case of a group event subscription. (NOTE 1) (NOTE 2) |
|
expiry |
DateTime |
C |
0..1 |
This IE shall be included in an event subscription response, if, based on operator policy and taking into account the expiry time included in the request, the AMF needs to include an expiry time. This IE may be included in an event subscription request. When present, this IE shall represent the time after which the subscribed event(s) shall stop generating report and the subscription becomes invalid. If the trigger value included in an event subscription response is "ONE_TIME" and if an event report is included in the subscription response then the value of the expiry included in the response shall be an immediate timestamp. (NOTE 1) |
|
repPeriod |
DurationSec |
C |
0..1 |
This IE shall be present if the trigger is set to "PERIODIC". When present, this IE describes the period time for the event reports. If the AMF event subscription is for a group of UEs, this parameter shall be applied to each individual member UE of the group. |
|
sampRatio |
SamplingRatio |
O |
0..1 |
This IE may be included in an event subscription request for a group of UEs or any UE to indicate the ratio of the random subset to target UEs. Event reports only relate to the subset. If the AMF event subscription is for a list of AMF event, this parameter shall be applied to each individual event. |
|
partitioningCriteria |
array(PartitioningCriteria) |
O |
1..N |
This IE may be included in an event subscription request for a group of UEs or any UE when sampRatio is provided. When present, this IE shall define the criteria for determining the UEs for which the sampling ratio shall apply. |
|
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. |
EneNA |
NOTE 1: If the AmfEventTrigger is set to "CONTINOUS", at least one of the "maxReports" and "expiry" attributes shall be included. NOTE 2: See NOTE 2 of Table 6.2.6.2.3-1 regarding the precedence between maxReports in AmfEvent and maxReports in this attribute. |
6.2.6.2.7 Type: AmfEventState
Table 6.2.6.2.7-1: Definition of type AmfEventState
Attribute name |
Data type |
P |
Cardinality |
Description |
active |
boolean |
M |
1 |
Represents the active state of the subscribe event. "TRUE" value indicates the event will continue generating reports; "FALSE" value indicates the event will not generate further report. |
remainReports |
integer |
O |
0..1 |
Represents the number of remain reports to be generated by the subscribed event. |
remainDuration |
DurationSec |
O |
0..1 |
Represents how long the subscribed event will continue generating reports. |
6.2.6.2.8 Type: RmInfo
Table 6.2.6.2.8-1: Definition of type RmInfo
Attribute name |
Data type |
P |
Cardinality |
Description |
rmState |
RmState |
M |
1 |
Describes the registration management state of the UE |
accessType |
AccessType |
M |
1 |
Describes the access type of the UE that applies to the registration management state reported. |
6.2.6.2.9 Type: CmInfo
Table 6.2.6.2.9-1: Definition of type CmInfo
Attribute name |
Data type |
P |
Cardinality |
Description |
cmState |
CmState |
M |
1 |
Describes the Connection management state of the UE |
accessType |
AccessType |
M |
1 |
Describes the access type of the UE that applies to the Connection management state reported. |
6.2.6.2.10 Void
6.2.6.2.11 Type: CommunicationFailure
Table 6.2.6.2.11-1: Definition of type CommunicationFailure
Attribute name |
Data type |
P |
Cardinality |
Description |
nasReleaseCode |
string |
O |
0..1 |
Describes the NAS release code for the communication failure. This IE shall be formatted following the regular expression pattern: "^(MM|SM)-[0-9]{1,3}$" Examples: MM-7 SM-27 |
ranReleaseCode |
NgApCause |
O |
0..1 |
Describes the RAN release code for the communication failure. If present, this IE shall contain the decimal value of the NG AP cause code values as specified in 3GPP TS 38.413 [12]. |
6.2.6.2.12 Type: AmfCreateEventSubscription
Table 6.2.6.2.12-1: Definition of type AmfCreateEventSubscription
Attribute name |
Data type |
P |
Cardinality |
Description |
subscription |
AmfEventSubscription |
M |
1 |
Represents the AMF Event Subscription resource to be created. |
supportedFeatures |
SupportedFeatures |
C |
0..1 |
This IE shall be present if at least one optional feature defined in clause 6.2.8 is supported. |
oldGuami |
Guami |
C |
0..1 |
This IE shall be present during an AMF planned removal procedure when the NF Service Consumer initiates a request towards the target AMF, for a UE associated to an AMF that is unavailable (see clause 5.21.2.2 of 3GPP TS 23.501 [2]). |
6.2.6.2.13 Type: AmfCreatedEventSubscription
Table 6.2.6.2.13-1: Definition of type AmfCreatedEventSubscription
Attribute name |
Data type |
P |
Cardinality |
Description |
subscription |
AmfEventSubscription |
M |
1 |
Represents the newly created AMF Event Subscription resource. |
subscriptionId |
Uri |
M |
1 |
Represents the URI of the newly created AMF Event Subscription resource. This shall contain an absolute URI set to the Resource URI specified in clause 6.2.3.3.2. (NOTE 2) |
reportList |
array(AmfEventReport) |
O |
1..N |
Represents the immediate event reports (i.e. the current value / status of the events subscribed), if available (NOTE 1). |
supportedFeatures |
SupportedFeatures |
C |
0..1 |
This IE shall be present if at least one optional feature defined in clause 6.2.8 is supported. |
NOTE 1: If the subscription is on behalf of another NF and the NF service consumer has not indicated supporting of IERSR feature (see 6.2.8), then the reports attribute shall be absent. NOTE 2: 3GPP TS 23.502 [3] specifies this attribute as "Subscription Correlation ID". |
6.2.6.2.14 Type: AmfUpdateEventSubscriptionItem
Table 6.2.6.2.14-1: Definition of type AmfUpdateEventSubscriptionItem
Attribute name |
Data type |
P |
Cardinality |
Description |
Applicability |
op |
string |
M |
1 |
This IE indicates the patch operation as defined in IETF RFC 6902 [14] to be performed on resource. This IE shall support the following values: Enum: "add" Enum: "replace" Enum: "remove" |
|
path |
string |
M |
1 |
This IE contains a JSON pointer value (as defined in IETF RFC 6901 [40]) that references a location of a resource on which the patch operation shall be performed. This IE shall contain the JSON pointer to a valid index of the "/eventList" array in the AMF Event Subscription, formatted with following pattern: ‘\/eventList\/[0-]$|\/eventList\/[1-9][0-9]*$’ Example: "/eventList/0" stands for the first member of the array; "/eventList/10" stands for the 11th member of the array; "/eventList/-" stands for a new (non-existent) member after the last existing array element. Only allowed with "add" operation. To update the PRA Information, this IE shall contain the JSON pointer to a valid key of the "/presenceInfoList" object in the AMF Event Subscription, the key shall be formatted as the "praId" attribute within the PresenceInfo data type. Pattern: ‘^(\/eventList\/0|\/eventList\/[1-9][0-9]*){1}(\/presenceInfoList\/0|\/presenceInfoList\/[1-9][0-9]*)?$’ Example: "/eventList/10/presenceInfoList/123" stands for the PresenceInfo with PRA ID 123 for the 11th member of the array. (NOTE 1) To remove list of group member UE(s) from a group subscription, this IE shall contain the JSON pointer to the "/excludeSupiList" object or "/excludeGpsiList" object in the AMF Event Subscription, Pattern: ‘^\/excludeSupiList|\/excludeGpsiList$’ (NOTE 2) To add list of group member UE(s) into a group subscription, this IE shall contain the JSON pointer to the "/includeSupiList" object or "/includeGpsiList" object in the AMF Event Subscription, Pattern: ‘^\/includeSupiList|\/includeGpsiList$’ (NOTE 3) |
|
value |
AmfEvent |
C |
0..1 |
This IE indicates a new AMF event to be added or updated value of an existing AMF event to be modified. It shall be present if the patch operation is "add" or "replace" |
|
presenceInfo |
PresenceInfo |
O |
0..1 |
This IE indicates a new PresenceInfo to be added or an existing PresenceInfo to be modified. The "presenceState" attribute within the PresenceInfo data type shall not be supplied. It shall be present if the patch operation is "add". |
MPRA |
excludeSupiList |
array(Supi) |
O |
1..N |
When present, this IE shall carry the SUPI of the group member UE(s) that are excluded from the group subscription. This IE shall be present if the path attribute containing JSON pointer to "/excludeSupiList" object and the patch operation is "add" and "replace". |
DGEM |
excludeGpsiList |
array(Gpsi) |
O |
1..N |
When present, this IE shall carry the GPSI of the group member UE(s) that are excluded from the group subscription. This IE shall be present if the path attribute containing JSON pointer to "/excludeGpsiList" object and the patch operation is "add" and "replace". |
DGEM |
includeSupiList |
array(Supi) |
O |
1..N |
When present, this IE shall carry the SUPI of the group member UE(s) that are included for the group subscription. This IE shall be present if the path attribute containing JSON pointer to "/includeSupiList" object and the patch operation is "add" and "replace". |
DGEM |
includeGpsiList |
array(Gpsi) |
O |
1..N |
When present, this IE shall carry the GPSI of the group member UE(s) that are included for the group subscription. This IE shall be present if the path attribute containing JSON pointer to "/includeGpsiList" object and the patch operation is "add" and "replace". |
DGEM |
NOTE 1: Update of PRA information by extending the schema of the path IE with JSON pointer to a valid key of the "/presenceInfoList" object shall only be used if the AMF supports the MPRA feature. NOTE 2: Remove group member UE(s) by extending the schema of the path IE with JSON pointer to the "/excludeSupiList" object or "/excludeGpsiList" object shall only be used if the AMF supports the DGEM feature. NOTE 3: Add group member UE(s) by extending the schema of the path IE with JSON pointer to the "/includeSupiList" object or "/includeGpsiList" object shall only be used if the AMF supports the DGEM feature. |
6.2.6.2.15 Type: AmfUpdatedEventSubscription
Table 6.2.6.2.15-1: Definition of type AmfUpdatedEventSubscription
Attribute name |
Data type |
P |
Cardinality |
Description |
subscription |
AmfEventSubscription |
M |
1 |
Represents the updated AMF Event Subscription resource. |
reportList |
array(AmfEventReport) |
O |
1..N |
Represents the immediate event reports (i.e. the current value / status of the events subscribed), if available (NOTE). |
NOTE: For newly added AMF event subscription(s) with the immediateFlag attribute set to true, immediate event report(s) of the corresponding AMF event subscription shall be provided if available. |
6.2.6.2.16 Type: AmfEventArea
Table 6.2.6.2.16-1: Definition of type AmfEventArea
Attribute name |
Data type |
P |
Cardinality |
Description |
Applicability |
presenceInfo |
PresenceInfo |
C |
0..1 |
This IE shall be present if the Area of Interest subscribed is not a LADN service area (e.g Presence Reporting Area or a list of TAIs / cell Ids) . (See NOTE1, NOTE 2) |
|
ladnInfo |
LadnInfo |
C |
0..1 |
This IE shall be present if the Area of Interest subscribed is a LADN service area. |
|
sNssai |
Snssai |
O |
0..1 |
When present, it shall contain the associated S-NSSAI of the area. |
ENA |
nsiId |
NsiId |
O |
0..1 |
When present, this IE shall contain the associated NSI ID of the S-NSSAI. |
ENA |
NOTE 1: When the AmfEventArea is provided during event subscription, then for UE specific presence reporting area subscription, the praId along with what constitutes that UE specific presence reporting area (i.e. set of Tai and/or set of ecgi and/or set of ncgi and/or set of globalRanNodeId) shall be provided. NOTE 2: If the subscription is for a Set of Core Network Predefined Presence Reporting Areas and both the AMF and the NF service consumer support the "APRA" feature, the PRA Identifier for the Set shall be carried in the "praId" IE and the individual PRA identifier shall be carried in the "additionalPraId" IE; if the subscription is for a Set of Core Network Predefined Presence Reporting Areas and the AMF or NF service consumer does not support the "APRA" feature, the individual PRA identifier shall be carried in the "praId" IE and the "additionalPraId" IE shall not be present. |
6.2.6.2.17 Type: LadnInfo
Table 6.2.6.2.17-1: Definition of type LadnInfo
Attribute name |
Data type |
P |
Cardinality |
Description |
ladn |
string |
M |
1 |
Represents the Local Access Data Network DNN. The AMF shall identify the list of tracking areas corresponding to the LADN DNN based on local configuration. |
presence |
PresenceState |
C |
0..1 |
This IE shall be included when the UE presence in area of interest is reported. When present, this IE contains the status of UE presence within the Area of Interest (IN / OUT / UNKNOWN). |
6.2.6.2.18 Type: AmfUpdateEventOptionItem
Table 6.2.6.2.18-1: Definition of type AmfUpdateEventOptionItem
Attribute name |
Data type |
P |
Cardinality |
Description |
Applicability |
op |
string |
M |
1 |
This IE indicates the patch operation as defined in IETF RFC 6902 [14] to be performed on resource. This IE shall support the following values: Enum: "replace" |
|
path |
string |
M |
1 |
This IE contains a JSON pointer value (as defined in IETF RFC 6901 [40]) that references a location of a resource on which the patch operation shall be performed. This IE shall contain the JSON pointer to "/options/expiry" attribute of the event subscription resource. Pattern: "\/options\/expiry$" To update the notifFlag attribute, this IE shall contain the JSON pointer to "/options/notifFlag" attribute of the event subscription resource. Pattern: "\/options\/notifFlag$" |
|
value |
DateTime |
M |
1 |
This IE indicates the updated expiry timer value as suggested by the NF service consumer. For update the notifFlag attribute, it shall contain the Null value. AMF shall ignore the value and not modify the expiry attribute. |
|
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. |
EneNA |
6.2.6.2.19 Type: 5GsUserStateInfo
Table 6.2.6.2.19-1: Definition of type 5GsUserStateInfo
Attribute name |
Data type |
P |
Cardinality |
Description |
5gsUserState |
5GsUserState |
M |
1 |
Describes the 5GS user state of the UE |
accessType |
AccessType |
M |
1 |
Describes the access type of the UE that applies to the 5GS user state reported. |
6.2.6.2.20 Type: TrafficDescriptor
Table 6.2.6.2.20-1: Definition of type TrafficDescriptor
Attribute name |
Data type |
P |
Cardinality |
Description |
dnn |
Dnn |
C |
0..1 |
This IE shall be present if it is available. When present, it shall indicate the Data Network Name. |
sNssai |
Snssai |
C |
0..1 |
This IE shall be present if it is available. When present, it shall indicate the associated S-NSSAI for the PDU Session. |
dddTrafficDescriptorList |
array(DddTrafficDescriptor) |
C |
1..N |
This IE shall be present if it is available. When present, it shall indicate the Traffic Descriptor related to the traffic. |
6.2.6.2.21 Type: UEIdExt
Table 6.2.6.2.21-1: Definition of type UEIdExt
Attribute name |
Data type |
P |
Cardinality |
Description |
supi |
Supi |
C |
0..1 |
This IE shall be present if available. When present, this IE identifies the SUPI of the UE associated with the report. |
gpsi |
Gpsi |
C |
0..1 |
This IE shall be present if available. When present, this IE identifies the GPSI of the UE associated with the report. |
6.2.6.2.22 Type: AmfEventSubsSyncInfo
Table 6.2.6.2.22-1: Definition of type AmfEventSubsSyncInfo
Attribute name |
Data type |
P |
Cardinality |
Description |
Applicability |
subscriptionList |
array(AmfEventSubscriptionInfo) |
M |
1..N |
This IE shall contain all active subscriptions in the AMF for the target UE. |
6.2.6.2.23 Type: AmfEventSubscriptionInfo
Table 6.2.6.2.23-1: Definition of type AmfEventSubscriptionInfo
Attribute name |
Data type |
P |
Cardinality |
Description |
Applicability |
subId |
Uri |
M |
1 |
This IE shall contain the URI of the subscription resource of events with Reference Id. |
|
notifyCorrelationId |
string |
M |
1 |
This IE shall contain the notification correlation ID of the subscription. |
|
refIdList |
array(ReferenceId) |
M |
1..N |
This IE shall contain the Reference Ids of the events in the subscription, one Reference Id per event. |
|
oldSubId |
Uri |
C |
0..1 |
This IE shall be present if new event subscription Id is created in the new AMF, i.e. the event subscription has been retrieved from an old AMF in UE context during EPS to 5GS mobility. When present, this IE shall include the URI of the subscription resouce on the source AMF. |
6.2.6.2.24 Type: TargetArea
Table 6.2.6.2.24-1: Definition of type TargetArea
Attribute name |
Data type |
P |
Cardinality |
Description |
taiList |
array(Tai) |
C |
1..N |
When present, this IE shall contain the list of TAIs. (NOTE) |
taiRangeList |
array(TaiRange) |
C |
1..N |
When present, this IE shall contain range(s) of TAIs. (NOTE) |
anyTa |
boolean |
C |
0..1 |
This IE shall be present if the event subscription is applicable to any TA. Default value "FALSE" is used, if not present (NOTE) |
NOTE: Either information about taList or taiRangeList or anyTa set to "TRUE" shall be included. |
6.2.6.2.25 Type: SnssaiTaiMapping
Table 6.2.6.2.25-1: Definition of type SnssaiTaiMapping
Attribute name |
Data type |
P |
Cardinality |
Description |
reportingArea |
TargetArea |
M |
1 |
This IE shall contain the list of TAIs/TAI ranges or anyTa. The taList and taiRangeList shall be absent, and the anyTa shall be set to "TRUE", if the mapping is related to all of the TAs in the AMF. |
accessTypeList |
array(AccessType) |
O |
1..N |
Describes the access type(s) of the reportingArea. |
supportedSnssaiList |
array(SupportedSnssai) |
C |
1..N |
This IE shall be present if available. When present, this IE represents the list of S-NSSAIs (including indication of S-NSSAIs restricted by AMF) at the reportingArea. |
6.2.6.2.26 Type: SupportedSnssai
Table 6.2.6.2.26-1: Definition of type SupportedSnssai
Attribute name |
Data type |
P |
Cardinality |
Description |
sNssai |
ExtSnssai |
M |
1 |
This IE shall contain the supported S-NSSAI. |
restrictionInd |
boolean |
O |
0..1 |
If present, this IE shall contain the indication if the S-NSSAI available in sNssai IE is restricted at the AMF. When present, this IE shall be set as follows: – true: the S-NSSAI available in sNssai IE is restricted at the AMF; – false (default): the S-NSSAI available in sNssai IE is not restricted at the AMF. |
6.2.6.2.27 Type: UeInAreaFilter
Table 6.2.6.2.27-1: Definition of type UeInAreaFilter
Attribute name |
Data type |
P |
Cardinality |
Description |
ueType |
UeType |
C |
0..1 |
When present, this IE shall contain the list of UE types. When this IE is received, The AMF shall report the number of UEs with the indicated UE type in the area. |
aerialSrvDnnInd |
boolean |
C |
0..1 |
When present, this IE shall contain an indication of DNN(s) subject to aerial service. Default value "FALSE" is used, if not present. This IE may be set to "TRUE" if the NF service consumer wants to retrieve the number of UEs in the area with established PDU sessions for DNN(s) subject to aerial service. |
NOTE: When the value of IE ueType is AERIAL_UE, the IE ueType and IE aerialSrvDnnInd shall be considered with "AND" for filtering. |
6.2.6.2.28 Type: IdleStatusIndication
Table 6.2.6.2.28-1: Definition of type IdleStatusIndication
Attribute name |
Data type |
P |
Cardinality |
Description |
Applicability |
timeStamp |
DateTime |
O |
0..1 |
Point in time when the UE returned to Idle |
|
activeTime |
DurationSec |
O |
0..1 |
Active Time granted to the UE. |
|
subsregTimer |
DurationSec |
O |
0..1 |
Subscribed periodic registration time. |
|
edrxCycleLength |
integer |
O |
0..1 |
Contains the eDRX cycle length in milliseconds. |
|
suggestedNumOfDlPackets |
integer |
O |
0..1 |
Suggested number of downlink packets to be buffered |
6.2.6.2.29 Type: UeAccessBehaviorReportItem
Table 6.2.6.2.29-1: Definition of type UeAccessBehaviorReportItem
Attribute name |
Data type |
P |
Cardinality |
Description |
Applicability |
stateTransitionType |
AccessStateTransitionType |
M |
1 |
Indicate the type the state transition behavior. |
|
spacing |
DurationSec |
M |
1 |
Indicates the average and variance of the time interval separating two consecutive occurrences of the state transition as indicated by the stateTransitionType IE. |
|
duration |
DurationSec |
M |
1 |
Indicate the average and variance of duration in the resulting state as indicated by stateTransitionType IE. |
6.2.6.2.30 Type: UeLocationTrendsReportItem
Table 6.2.6.2.30-1: Definition of type UeLocationTrendsReportItem
Attribute name |
Data type |
P |
Cardinality |
Description |
Applicability |
tai |
Tai |
C |
0..1 |
Indicates the TAI where the UE arrived. (NOTE) |
|
ncgi |
Ncgi |
C |
0..1 |
Indicates the NR cell where the UE arrived. (NOTE) |
|
ecgi |
Ecgi |
C |
0..1 |
Indicates the EUTRAN cell where the UE arrived. (NOTE) |
|
n3gaLocation |
N3gaLocation |
C |
0..1 |
Indicates the Non-3GPP location where the UE arrived. (NOTE) |
|
spacing |
DurationSec |
M |
1 |
Indicates the average and variance of the time interval separating two consecutive arrivals at the indicated location. |
|
duration |
DurationSec |
M |
1 |
Indicate the average and variance of duration of stay in the indicated location. |
|
timestamp |
DateTime |
M |
1 |
Indicates the date and time of UE last arrival to the indicated location. |
|
NOTE: At least one of the "tai", "ncgi", "ecgi" and "n3gaLocation" shall be present. |
6.2.6.2.31 Type: DispersionArea
Table 6.2.6.2.31-1: Definition of type DispersionArea
Attribute name |
Data type |
P |
Cardinality |
Description |
Applicability |
taiList |
array(Tai) |
C |
1..N |
Indicates the TAIs where the UE information to be counted for Dispersion Analytics. (NOTE) |
|
ncgiList |
array(Ncgi) |
C |
1..N |
Indicates the NR cells where the UE information to be counted for Dispersion Analytics. (NOTE) |
|
ecgiList |
array(Ecgi) |
C |
1..N |
Indicates the EUTRAN cells where the UE information to be counted for Dispersion Analytics. (NOTE) |
|
n3gaInd |
boolean |
C |
0..1 |
Indicates whether that the UE information shall be counted for Non-3GPP access or not. When present, it should be set as following: – true: The UE information shall be counted for Non-3GPP access. – false (default): the UE information for Non-3GPP access shall not be counted. |
|
NOTE: One and only one of the "taiList", "ncgiList", "ecgiList" or "n3gaInd" shall be present. |
6.2.6.2.32 Type: MmTransactionLocationReportItem
Table 6.2.6.2.32-1: Definition of type MmTransactionLocationReportItem
Attribute name |
Data type |
P |
Cardinality |
Description |
Applicability |
tai |
Tai |
C |
0..1 |
Indicates the TAI where the UE MM transactions are counted. (NOTE) |
|
ncgi |
Ncgi |
C |
0..1 |
Indicates the NR cell where the UE MM transations are counted. (NOTE) |
|
ecgi |
Ecgi |
C |
0..1 |
Indicates the EUTRAN cell where the UE MM transations are counted. (NOTE) |
|
n3gaLocation |
N3gaLocation |
C |
0..1 |
Indicates the Non-3GPP location where UE MM transations are counted. (NOTE) |
|
timestamp |
DateTime |
M |
1 |
Indicates the timestamp when the UE enters the location. |
|
transactions |
integer |
M |
1 |
Totally number of UE MM Transactions counted within the location. |
|
NOTE: At least one of the "tai", "ncgi" or "ecgi" shall be present. |
6.2.6.2.33 Type: MmTransactionSliceReportItem
Table 6.2.6.2.33-1: Definition of type MmTransactionSliceReportItem
Attribute name |
Data type |
P |
Cardinality |
Description |
Applicability |
snssai |
Snssai |
M |
1 |
Indicates the S-NSSAI of the slice where the UE MM Transactions are counted. |
|
timestamp |
DateTime |
M |
1 |
Indicates the timestamp when the slice is assigned to the UE. (NOTE) |
|
transactions |
integer |
M |
1 |
Totally number of UE MM Transactions counted for the indicated slice. |
|
NOTE: The timestamps for assigned slices of a UE are not passed between AMFs, i.e. when a UE moves to a new AMF the timestamps for assigned slices of the UE are set to the date and time when the mobility happened in the new AMF. |
6.2.6.3 Simple data types and enumerations
6.2.6.3.1 Introduction
This clause defines simple data types and enumerations that can be referenced from data structures defined in the previous clauses.
6.2.6.3.2 Simple data types
The simple data types defined in table 6.2.6.3.2-1 shall be supported.
Table 6.2.6.3.2-1: Simple data types
Type Name |
Type Definition |
Description |
6.2.6.3.3 Enumeration: AmfEventType
Table 6.2.6.3.3-1: Enumeration AmfEventType
Enumeration value |
Description |
"LOCATION_REPORT" |
A NF subscribes to this event to receive the Last Known Location or the current Location of a UE or a group of UEs, and Updated Location of the UE or any UE in the group when AMF becomes aware of a location change of the UE. |
"PRESENCE_IN_AOI_REPORT" |
A NF subscribes to this event to receive the current present state of a UE in a specific Area of Interest (AOI), and notification when a specified UE enters or leaves the specified area. The area could be identified by a TA list, an area ID or specific interest area name like "LADN". |
"TIMEZONE_REPORT" |
A NF subscribes to this event to receive the current time zone of a UE or a group of UEs, and updated time zone of the UE or any UE in the group when AMF becomes aware of a time zone change of the UE. |
"ACCESS_TYPE_REPORT" |
A NF subscribes to this event to receive the current access type(s) of a UE or a group of UEs, and updated access type(s) of the UE or any UE in the group when AMF becomes aware of the access type change of the UE. |
"REGISTRATION_STATE_REPORT" |
A NF subscribes to this event to receive the current registration state of a UE or a group of UEs, and report for updated registration state of a UE or any UE in the group when AMF becomes aware of a registration state change of the UE. |
"CONNECTIVITY_STATE_REPORT" |
A NF subscribes to this event to receive the current connection management state of a UE or a group of UEs, and report for updated connection management state of a UE or any UE in the group when AMF becomes aware of a connection management state change of the UE. |
"REACHABILITY_REPORT" |
A NF subscribes to this event to receive the current reachability of a UE or a group of UEs, and report for updated reachability of a UE or any UE in the group when AMF becomes aware of a reachability change of the UE. |
"COMMUNICATION_FAILURE_REPORT" |
A NF subscribes to this event to receive the Communication failure report of a UE or group of UEs or any UE. |
"UES_IN_AREA_REPORT" |
A NF subscribes to this event to receive the number of UEs in a specific area. |
"SUBSCRIPTION_ID_CHANGE" |
This event type is used by the AMF to inform the NF service consumer that the subscription Id for the event subscription is changed (e.g. Subscription Id creation at the target AMF for individual UE level event subscriptions, during mobility registration or handover procedures involving an AMF change). This event needs no explicit subscription form an NF service consumer. |
"SUBSCRIPTION_ID_ADDITION" |
This event type is used by the AMF to inform the NF service consumer that a new subscription Id is added (e.g creation of an event subscription for a UE group level event subscription at the target AMF, during mobility registration or handover procedures involving AMF change for a UE belonging to a group Id and when such a UE is the first UE of the group registering at the target AMF). This event needs no explicit subscription form the NF service consumer. |
"SUBSCRIPTION_TERMINATION" |
This event type is used by the AMF to inform the NF service consumer that the subscription is terminated at the AMF, e.g. the AMF inform the UDM that the subscription is terminated because the AMF has identified the subscription is no longer valid at the NEF. |
"LOSS_OF_CONNECTIVITY" |
An NF subscribes to this event to receive the event report of a UE or group of UEs when AMF detects that a target UE is no longer reachable for either signalling or user plane communication. Such condition is identified when Mobile Reachable timer expires in the AMF (see 3GPP TS 23.501 [2]), when the UE detaches and when AMF deregisters from UDM for an active UE. If the UE is already not reachable for either signalling or user plane communication when the event is subscribed, the AMF reports the event directly. |
"5GS_USER_STATE_REPORT" |
A NF subscribes to this event to receive the 5GS user state of a UE. |
"AVAILABILITY_AFTER_DDN_FAILURE" |
A NF subscribes to this event to be notified about the Availability of a UE after a DDN failure. |
"TYPE_ALLOCATION_CODE_REPORT" |
A NF subscribes to this event to receive the TAC of a UE or group of UEs. |
"FREQUENT_MOBILITY_REGISTRATION_REPORT" |
A NF subscribes to this event to receive the number of mobility registration procedures during a period of a UE or group of UEs. |
"SNSSAI_TA_MAPPING_REPORT" |
A NF subscribes to this event to receive the related access type and the list of supported S-NSSAIs (including indication of S-NSSAIs restricted by AMF) at the TAI(s). |
"UE_ACCESS_BEHAVIOR_TRENDS" |
A NF subscribes to this event to receive the UE access behavior trends (e.g. access type change, handover, etc.) during a period for a UE or a group of UEs, as specified in clause 4.15.4.2 of 3GPP TS 23.502 [3]. |
"UE_LOCATION_TRENDS" |
A NF subscribes to this event to receive the UE Location Trends within a period for a UE or a group of UEs, as specified in clause 4.15.4.2 of 3GPP TS 23.502 [3]. |
"UE_MM_TRANSACTION_REPORT" |
A NF subscribes to this event to receive the Total Number of Mobility Management transactions during a period for a UE or a group of UEs, as specified in clause 5.2.2.3.1 of 3GPP TS 23.502 [3]. |
6.2.6.3.4 Enumeration: AmfEventTrigger
Table 6.2.6.3.4-1: Enumeration AmfEventTrigger
Enumeration value |
Description |
"ONE_TIME" |
Defines that AMF should generate report for the event only once. After reporting, the subscription to this event will be terminated. |
"CONTINUOUS" |
Defines that AMF should continuously generate reports for the event, until the subscription to this event ends, due to end of report duration or up to the maximum number of reports or the event being unsubscribed explicitly |
"PERIODIC" |
Defines that AMF should periodically generate reports for the event, until the subscription to this event ends, due to end of report duration or up to the maximum number of reports or the event being unsubscribed explicitly. |
6.2.6.3.5 Enumeration: LocationFilter
Table 6.2.6.3.5-1: Enumeration LocationFilter
Enumeration value |
Description |
"TAI" |
Indicates any change of the TA used by the UE should be reported |
"CELL_ID" |
Indicates any change of the Cell used by the UE should be reported |
"RAN_NODE" |
Indicates any change of the RAN node serving the UE shall be reported. |
"N3IWF" |
Indicates any change of the N3IWF node used by the UE should be reported |
"UE_IP" |
Indicates any change of the UE local IP address should be reported |
"UDP_PORT" |
Indicates any change of local UDP port used by the UE reported |
"TNAP_ID" |
Indicates any change of the TNAP ID used by the UE should be reported |
"GLI" |
Indicates any change of the Global Line Id used by the UE should be reported |
"TWAP_ID" |
Indicates any change of the TWAP ID used by the UE should be reported |
6.2.6.3.6 Void
6.2.6.3.7 Enumeration: UeReachability
Table 6.2.6.3.7-1: Enumeration UeReachability
Enumeration value |
Description |
"UNREACHABLE" |
Indicates the UE is not reachable, e.g. when the Mobile Reachable Timer in AMF expires. |
"REACHABLE" |
Indicates the UE is reachable for services and downlink traffic. |
"REGULATORY_ONLY" |
Indicates the UE is reachable only for Regulatory Prioritized Service as the UE is in Not Allowed Areas. |
6.2.6.3.8 Void
6.2.6.3.9 Enumeration: RmState
Table 6.2.6.3.9-1: Enumeration RmState
Enumeration value |
Description |
"REGISTERED" |
Indicates the UE in RM-REGISTERED state |
"DEREGISTERED" |
Indicates the UE in RM-DEREGISTERED state |
6.2.6.3.10 Enumeration: CmState
Table 6.2.6.3.10-1: Enumeration CmState
Enumeration value |
Description |
"IDLE" |
Indicates the UE is in CM-IDLE state |
"CONNECTED" |
Indicates the UE is in CM-CONNECTED state |
6.2.6.3.11 Enumeration: 5GsUserState
Table 6.2.6.3.11-1: Enumeration 5GsUserState
Enumeration value |
Description |
"DEREGISTERED" |
Indicates the UE in RM-DEREGISTERED state |
"CONNECTED_NOT_REACHABLE_FOR_PAGING" |
Indicates the UE is in the RM-REGISTERED state in 5GS and the UE is not reachable for paging. |
"CONNECTED_REACHABLE_FOR_PAGING" |
Indicates the UE is in the RM-REGISTERED state in 5GS and the UE is reachable for paging. |
"NOT_PROVIDED_FROM_AMF" |
Indicates that the 5GS User State cannot be retrieved from the AMF (NOTE) |
NOTE: This value is not sent by AMF (it may be sent by UDM to HSS). |
6.2.6.3.12 Enumeration: LossOfConnectivityReason
Table 6.2.6.3.12-1: Enumeration LossOfConnectivityReason
Enumeration value |
Description |
"DEREGISTERED" |
Indicates the UE is deregistered. |
"MAX_DETECTION_TIME_EXPIRED" |
Indicates the mobile reachable timer is expired. |
"PURGED" |
Indicates the UE is purged. |
6.2.6.3.13 Enumeration: ReachabilityFilter
Table 6.2.6.3.13-1: Enumeration ReachabilityFilter
Enumeration value |
Description |
"UE_REACHABILITY_STATUS_CHANGE" |
Indicates subscription for "UE Reachability Status Change". |
"UE_REACHABLE_DL_TRAFFIC" |
Indicates subscription for "UE Reachable for DL Traffic". |
6.2.6.3.14 Enumeration: UeType
Table 6.2.6.3.14-1: Enumeration UeType
Enumeration value |
Description |
"AERIAL_UE" |
Indicates the UE is an Aerial UE |
6.2.6.3.15 Enumeration: AccessStateTransitionType
Table 6.2.6.3.15-1: Enumeration AccessStateTransitionType
Enumeration value |
Description |
"ACCESS_TYPE_CHANGE_3GPP" |
Indicates that the UE’s access type has changed to 3GPP access. |
"ACCESS_TYPE_CHANGE_N3GPP" |
Indicates that the UE’s access type has changed to non-3GPP access. |
"RM_STATE_CHANGE_DEREGISTERED" |
Indicates that the UE’s RM state has change to RM-DEREGISTERED. |
"RM_STATE_CHANGE_REGISTERED" |
Indicates that the UE’s RM state has change to RM-REGISTERED. |
"CM_STATE_CHANGE_IDLE" |
Indicates that the UE’s CM state has change to CM-IDLE. |
"CM_STATE_CHANGE_CONNECTED" |
Indicates that the UE’s CM state has change to CM-CONNECTED |
"HANDOVER" |
Indicates that the UE has performed a successful handover. |
"MOBILITY_REGISTRATION_UPDATE" |
Indicates that the UE has performed a successful mobility registration update. |
6.2.6.3.16 Enumeration: SubTerminationReason
Table 6.2.6.3.16-1: Enumeration SubTerminationReason
Enumeration value |
Description |
"INVALID_SUBSCRIPTION" |
Indicates that the subscription is terminated because the AMF has identified that the subscription is no longer valid on the NF hosting the notification URI. |
6.2.6.4 Binary data
None.
6.2.7 Error Handling
6.2.7.1 General
HTTP error handling shall be supported as specified in clause 5.2.4 of 3GPP TS 29.500 [4].
6.2.7.2 Protocol Errors
Protocol Error Handling shall be supported as specified in clause 5.2.7 of 3GPP TS 29.500 [4].
6.2.7.3 Application Errors
The common application errors defined in the Table 5.2.7.2-1 in 3GPP TS 29.500 [4] may also be used for the Namf_EventExposure service, and the following application errors listed in Table 6.2.7.3-1 are specific for the Namf_EventExposure service.
Table 6.2.7.3-1: Application errors
Application Error |
HTTP status code |
Description |
UE_NOT_SERVED_BY_AMF |
403 Forbidden |
Indicates the creation or the modification of a subscription has failed due to an application error when the UE is not served by the AMF. |
UNSPECIFIED |
403 Forbidden |
The request is rejected due to unspecified reasons. |
SUBSCRIPTION_NOT_FOUND |
404 Not Found |
Indicates the modification of subscription has failed due to an application error when the subscription is not found in the AMF. |
6.2.8 Feature Negotiation
The feature negotiation mechanism specified in clause 6.6 of 3GPP TS 29.500 [4] shall be used to negotiate the optional features applicable between the AMF and the NF Service Consumer, for the Namf_EventExposure service, if any.
The NF Service Consumer shall indicate the optional features it supports for the Namf_EventExposure service, if any, by including the supportedFeatures attribute in payload of the HTTP Request Message for subscription resource creation.
The AMF shall determine the supported features for the service operations as specified in clause 6.6 of 3GPP TS 29.500 [4] and shall indicate the supported features by including the supportedFeatures attribute in payload of the HTTP response for subscription resource creation.
The syntax of the supportedFeatures attribute is defined in clause 5.2.2 of 3GPP TS 29.571 [6].
The following features are defined for the Namf_EventExposure service:
Table 6.2.8-1: Features of supportedFeatures attribute used by Namf_EventExposure service
Feature Number |
Feature |
M/O |
Description |
1 |
ENA |
O |
Enablers for Network Automation for 5G An AMF and an NF that support this feature shall support the procedures specified in 3GPP TS 23.288 [38]. |
2 |
APRA |
O |
Additional Presence Reporting Area An AMF that supports this feature shall support subscription of "PRESENCE_IN_AOI_REPORT" event with a Set of Core Network Predefined Presence Reporting Areas and generating event report including both PRA Set ID and additional PRA ID referring to an individual PRA in the Set. An NF service consumer that supports this feature shall support receiving "PRESENCE_IN_AOI_REPORT" event with additional PRA ID referring to an individual PRA in the Set. |
3 |
ESSYNC |
O |
Event Subscription Synchronization An AMF and UDM that supports this feature shall support the event subscription synchronization procedure, as specified in clause 5.3.2.4.2. |
4 |
ES3XX |
M |
Extended Support of HTTP 307/308 redirection An NF Service Consumer (e.g. NEF) that supports this feature shall support handling of HTTP 307/308 redirection for any service operation of the Namf_EventExposure service. An NF Service Consumer that does not support this feature does only support HTTP redirection as specified for 3GPP Release 15. |
5 |
IERSR |
O |
Immediate Event Report in Subscription Creation Response for Subscriptions on behalf of another NF An NF consumer (e.g. UDM) supporting this feature shall be able to handle the immediate event reports in the Subscription Creation Response for subscriptions on behalf of another NF, as specified in clause 5.3.2.2.2. |
6 |
EneNA |
O |
Enhancement of Enablers for Network Automation for 5G An AMF and an NF that support this feature shall support the enhancement of network data analytics specified in 3GPP TS 23.288 [38]. |
7 |
DGEM |
O |
Dynamic Group-based Event Monitoring An AMF supporting this feature shall allow the NF consumer to remove list of group member UE(s) for a group-based event monitoring subscription (see clause 5.3.2.2.4). |
8 |
UARF |
O |
UEs in Area Report Filter This feature indicates the support of enhanced filter for UEs-In-Area-Report event. When this feature is supported at the AMF, the AMF shall apply additional filters provided in ueInAreaFilter IE. |
9 |
MPRA |
O |
Map type PRA information Support of this feature implies support of map type presenceInfoList during subscription creation and support of PresenceInfo modification during subscription modification (see clauses 6.2.6.2.3 and 6.2.6.2.14). |
10 |
STEN |
O |
Subscription Termination Event Notification An AMF supporting this feature shall support sending a notification to the NF consumer to inform that the AMF event subscription is terminated if requested by NF consumer; an NF consumer supporting this feature shall support processing the Subscription Termination Event Notification from the AMF, e.g. clean-up the local context for the indicated AMF event subscription. |
Feature number: The order number of the feature within the supportedFeatures attribute (starting with 1). Feature: A short name that can be used to refer to the bit and to the feature. M/O: Defines if the implementation of the feature is mandatory ("M") or optional ("O"). Description: A clear textual description of the feature. |
6.2.9 Security
As indicated in 3GPP TS 33.501 [27], the access to the Namf_EventExposure API may be authorized by means of the OAuth2 protocol (see IETF RFC 6749 [28]), using the "Client Credentials" authorization grant, where the NRF (see 3GPP TS 29.510 [29]) plays the role of the authorization server.
If Oauth2 authorization is used, an NF Service Consumer, prior to consuming services offered by the Namf_EventExposure API, shall obtain a "token" from the authorization server, by invoking the Access Token Request service, as described in 3GPP TS 29.510 [29], clause 5.4.2.2.
NOTE: When multiple NRFs are deployed in a network, the NRF used as authorization server is the same NRF that the NF Service Consumer used for discovering the Namf_EventExposure service.
The Namf_EventExposure API defines scopes for OAuth2 authorization as specified in 3GPP TS 33.501 [27]; it defines a single scope consisting on the name of the service (i.e., "namf-evts"), and it does not define any additional scopes at resource or operation level.
6.2.10 HTTP redirection
An HTTP request may be redirected to a different AMF service instance, within the same AMF or a different AMF of an AMF set, e.g. when an AMF service instance is part of an AMF (service) set or when using indirect communications (see 3GPP TS 29.500 [4]). See the ES3XX feature in clause 6.2.8.
An SCP that reselects a different AMF producer instance will return the NF Instance ID of the new AMF producer instance in the 3gpp-Sbi-Producer-Id header, as specified in clause 6.10.3.4 of 3GPP TS 29.500 [4].
If an AMF within an AMF set redirects a service request to a different AMF of the set using an 307 Temporary Redirect or 308 Permanent Redirect status code, the identity of the new AMF towards which the service request is redirected shall be indicated in the 3gpp-Sbi-Target-Nf-Id header of the 307 Temporary Redirect or 308 Permanent Redirect response as specified in clause 6.10.9.1 of 3GPP TS 29.500 [4].