6.1.6 Data Model
29.5183GPP5G SystemAccess and Mobility Management ServicesRelease 18Stage 3TS
6.1.6.1 General
This clause specifies the application data model supported by the API.
Table 6.1.6.1-1 specifies the data types defined for the Namf_Communication service based interface protocol.
Table 6.1.6.1-1: Namf_Communication specific Data Types
Data type |
Clause defined |
Description |
SubscriptionData |
6.1.6.2.2 |
Data within an AMF Status Change Subscription request and response. |
AmfStatusChangeNotification |
6.1.6.2.3 |
Data within an AMF Status Change Notification request. |
AmfStatusInfo |
6.1.6.2.4 |
AMF Status Information |
AssignEbiData |
6.1.6.2.5 |
Data within an EBI assignment request. |
AssignedEbiData |
6.1.6.2.6 |
Data within a successful response to an EBI assignment request. |
AssignEbiFailed |
6.1.6.2.7 |
Represents failed assignment of EBI(s) |
UEContextRelease |
6.1.6.2.8 |
Data within a Release UE Context request. |
N2InformationTransferReqData |
6.1.6.2.9 |
Data within a N2 Information Transfer request containing the N2 information requested to be transferred to 5G AN. |
NonUeN2InfoSubscriptionCreateData |
6.1.6.2.10 |
Data within a create subscription requestfor non-UE specific N2 information notification. |
NonUeN2InfoSubscriptionCreatedData |
6.1.6.2.11 |
Data for the created subscription for non-UE specific N2 information notification. |
UeN1N2InfoSubscriptionCreateData |
6.1.6.2.12 |
Data within a create subscription request for UE specific N1 and/or N2 information notification. |
UeN1N2InfoSubscriptionCreatedData |
6.1.6.2.13 |
Data for the created subscription for UE specific N1 and/or N2 information notification. |
N2InformationNotification |
6.1.6.2.14 |
Data within a N2 information notification request. |
N2InfoContainer |
6.1.6.2.15 |
N2 information container. |
N1MessageNotification |
6.1.6.2.16 |
Data within a N1 message notification request. |
N1MessageContainer |
6.1.6.2.17 |
N1 Message Container. |
N1N2MessageTransferReqData |
6.1.6.2.18 |
Data within a N1/N2 message transfer request. |
N1N2MessageTransferRspData |
6.1.6.2.19 |
Data within a N1/N2 message transfer response. |
RegistrationContextContainer |
6.1.6.2.20 |
Registration Context Container used to send the UE context information, N1 message from UE, AN address etc during Registration with AMF re-allocation procedure. |
AreaOfValidity |
6.1.6.2.21 |
Area of validity information for N2 information transfer |
UeContextTransferReqData |
6.1.6.2.23 |
Data within a UE Context Transfer Request to start transferring of an individual ueContext resource from old AMF to new AMF. |
UeContextTransferRspData |
6.1.6.2.24 |
Data within a successful response to the UE Context Transfer request. |
UeContext |
6.1.6.2.25 |
Represents an individual ueContext resource |
N2SmInformation |
6.1.6.2.26 |
Represents the session management SMF related N2 information data part. |
N2InfoContent |
6.1.6.2.27 |
Represents a transparent N2 information content to be relayed by AMF. |
NrppaInformation |
6.1.6.2.28 |
Represents a NRPPa related N2 information data part. |
PwsInformation |
6.1.6.2.29 |
Represents a PWS related information data part. |
N1N2MsgTxfrFailureNotification |
6.1.6.2.30 |
Data within a N1/N2 Message Transfer Failure Notification request |
N1N2MessageTransferError |
6.1.6.2.31 |
Data within a N1/N2 Message Transfer Error response. |
N1N2MsgTxfrErrDetail |
6.1.6.2.32 |
N1/N2 Message Transfer Error Details |
N2InformationTransferRspData |
6.1.6.2.33 |
Data within a successful response to the N2 Information Transfer request to transfer N2 Information to the AN. |
MmContext |
6.1.6.2.34 |
Represents a Mobility Management Context in UE Context |
SeafData |
6.1.6.2.35 |
Represents SEAF data derived from data received from AUSF |
NasSecurityMode |
6.1.6.2.36 |
Indicates the NAS Security Mode |
PduSessionContext |
6.1.6.2.37 |
Represents a PDU Session Context in UE Context |
NssaiMapping |
6.1.6.2.38 |
Represents the mapping between a S-NSSAI in serving PLMN to a S-NSSAI in home PLMN. |
UeRegStatusUpdateReqData |
6.1.6.2.39 |
Data within a UE registration status update request to indicate a completion of transferring at a target AMF. |
AssignEbiError |
6.1.6.2.40 |
Data within a failure response to the EBI assignment request. |
UeContextCreateData |
6.1.6.2.41 |
Data within a request to create an individual ueContext resource |
UeContextCreatedData |
6.1.6.2.42 |
Data within a successful response for creating an individual ueContext resource |
UeContextCreateError |
6.1.6.2.43 |
Data within a failure response for creating a UE context |
NgRanTargetId |
6.1.6.2.44 |
Indicates a NG RAN as target of the handover |
N2InformationTransferError |
6.1.6.2.45 |
Data within a failure response for a non-UE related N2 Information Transfer. |
PWSResponseData |
6.1.6.2.46 |
Data related PWS included in a N2 Information Transfer response. |
PWSErrorData |
6.1.6.2.47 |
Data related to PWS error included in a N2 Information Transfer failure response. |
NgKsi |
6.1.6.2.49 |
Represents the ngKSI (see 3GPP TS 33.501 [27]) |
KeyAmf |
6.1.6.2.50 |
Represents the Kamf or K’amf. (see 3GPP TS 33.501 [27]). |
ExpectedUeBehavior |
6.1.6.2.51 |
Represents the expected UE behavior (e.g. UE moving trajectory) and its validity period. |
UeRegStatusUpdateRspData |
6.1.6.2.52 |
Data within a UE registration status update response to provides the status of UE context transfer status update at a source AMF. |
N2RanInformation |
6.1.6.2.53 |
Represents the RAN related N2 information data part. |
N2InfoNotificationRspData |
6.1.6.2.54 |
Data within a N2 information notification response. |
SmallDataRateStatusInfo |
6.1.6.2.55 |
Represents the small data rate status |
SmfChangeInfo |
6.1.6.2.56 |
SMF change information for PDU session(s) |
V2xContext |
6.1.6.2.57 |
Represents the V2X services related parameters |
ImmediateMdtConf |
6.1.6.2.58 |
Immediate MDT Configuration |
V2xInformation |
6.1.6.2.59 |
V2X related N2 information |
EpsNasSecurityMode |
6.1.6.2.60 |
Indicates the EPS NAS Security Mode |
UeContextRelocateData |
6.1.6.2.61 |
Data within a Relocate UE Context request |
UeContextRelocatedData |
6.1.6.2.62 |
Data within a Relocate UE Context |
EcRestrictionDataWb |
6.1.6.2.64 |
Enhanced Coverage Restriction Data for WB-N1 mode. |
ExtAmfEventSubscription |
6.1.6.2.65 |
AMF event subscription extended with additional information received for the subscription |
AmfEventSubscriptionAddInfo |
6.1.6.2.66 |
Additional information received for an AMF event subscription, e.g. binding indications. |
UeContextCancelRelocateData |
6.1.6.2.67 |
Data structure used for cancellation of UE Context Relocation. |
UeDifferentiationInfo |
6.1.6.2.68 |
Represents the UE Differentiation Information and its validity time. |
CeModeBInd |
6.1.6.2.69 |
CE-mode-B Support Indicator |
LteMInd |
6.1.6.2.70 |
LTE-M Indication |
NpnAccessInfo |
6.1.6.2.71 |
NPN Access Information |
ProseContext |
6.1.6.2.72 |
Represents the ProSE services related parameters |
AnalyticsSubscription |
6.1.6.2.73 |
Analytics subscriptions created in the NWDAF. |
NwdafSubscription |
6.1.6.2.74 |
Individual NWDAF subscription identified by the subscription Id. |
UpdpSubscriptionData |
6.1.6.2.75 |
UE policy delivery related N1 message notification subscription data |
ProSeInformation |
6.1.6.2.76 |
5G ProSe related N2 information. |
ReleaseSessionInfo |
6.1.6.2.77 |
PDU session Id(s) and the cause for triggering the release |
AreaOfInterestEventState |
6.1.6.2.78 |
Area Of Interest Event State in old AMF |
EpsBearerId |
6.1.6.3.2 |
EPS Bearer Identifier |
Ppi |
6.1.6.3.2 |
Paging Policy Indicator |
NasCount |
6.1.6.3.2 |
Represents a NAS COUNT |
5GMmCapability |
6.1.6.3.2 |
Represents a 5GMM capability |
UeSecurityCapability |
6.1.6.3.2 |
Represents a UE Security Capability |
S1UeNetworkCapability |
6.1.6.3.2 |
Represents a S1 UE Network Capability |
DrxParameter |
6.1.6.3.2 |
Indicates the UE DRX Parameters |
OmcIdentifier |
6.1.6.3.2 |
Represents the OMC Identifier |
MSClassmark2 |
6.1.6.3.2 |
Indicates the MS Classmark 2 of a 5G SRVCC UE |
SupportedCodec |
6.1.6.3.2 |
Indicates the supported codec of a 5G SRVCC UE |
StatusChange |
6.1.6.3.3 |
Enumeration for AMF status |
N2InformationClass |
6.1.6.3.4 |
Enumeration for N2 Information Class |
N1MessageClass |
6.1.6.3.5 |
Enumeration for N1 Message Class |
N1N2MessageTransferCause |
6.1.6.3.6 |
Enumeration for N1N2Message Transfer Cause |
UeContextTransferStatus |
6.1.6.3.7 |
Describes the status of an individual ueContext resource in UE Context Transfer procedures |
N2InformationTransferResult |
6.1.6.3.8 |
Describes the result of N2 information transfer by AMF to the AN. |
CipheringAlgorithm |
6.1.6.3.9 |
Indicates the supported Ciphering Algorithm |
IntegrityAlgorithm |
6.1.6.3.10 |
Indicates the supported Integrity Algorithm |
SmsSupport |
6.1.6.3.11 |
Indicates the supported SMS delivery of a UE. |
ScType |
6.1.6.3.12 |
Indicates the security context type. |
KeyAmfType |
6.1.6.3.13 |
Indicates the Kamf type. |
TransferReason |
6.1.6.3.14 |
Indicates UE Context Transfer Reason |
PolicyReqTrigger |
6.1.6.3.15 |
Policy Request Triggers |
RatSelector |
6.1.6.3.16 |
Indicates the RAT type for the transfer of N2 information |
NgapIeType |
6.1.6.3.17 |
Indicates the supported NGAP IE types |
N2InfoNotifyReason |
6.1.6.3.18 |
N2 Information Notify Reason |
SmfChangeIndication |
6.1.6.3.19 |
Indicates the I-SMF or V-SMF change or removal |
SbiBindingLevel |
6.1.6.3.20 |
SBI Binding Level |
EpsNasCipheringAlgorithm |
6.1.6.3.21 |
Indicates the supported EPS NAS Ciphering Algorithm |
EpsNasIntegrityAlgorithm |
6.1.6.3.22 |
Indicates the supported EPS NAS Integrity Algorithm |
PeriodicCommunicationIndicator |
6.1.6.3.23 |
Indicates the Periodic Communication Indicator |
UuaaMmStatus |
6.1.6.3.24 |
Indicates UUAA-MM status |
ReleaseCause |
6.1.6.3.25 |
The cause for triggering the release |
Table 6.1.6.1-2 specifies data types re-used by the Namf 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 service based interface.
Table 6.1.6.1-2: Namf re-used Data Types
Data type |
Reference |
Comments |
Snssai |
3GPP TS 29.571 [6] |
|
Arp |
3GPP TS 29.571 [6] |
|
PduSesisonId |
3GPP TS 29.571 [6] |
|
Guami |
3GPP TS 29.571 [6] |
Globally Unique AMF Identifier |
AmfName |
3GPP TS 29.571 [6] |
The name of the AMF |
Supi |
3GPP TS 29.571 [6] |
Subscription Permanent Identifier |
Cause |
3GPP TS 29.571 [6] |
5G-AN Cause |
ProblemDetails |
3GPP TS 29.571 [6] |
Detailed problems in failure case |
supportedFeatures |
3GPP TS 29.571 [6] |
Supported Features |
TimeZone |
3GPP TS 29.571 [6] |
|
UserLocation |
3GPP TS 29.571 [6] |
|
AccessType |
3GPP TS 29.571 [6] |
|
AllowedNssai |
3GPP TS 29.531 [18] |
|
NfInstanceId |
3GPP TS 29.571 [6] |
|
Uri |
3GPP TS 29.571 [6] |
|
Ecgi |
3GPP TS 29.571 [6] |
EUTRA Cell Identifier |
Ncgi |
3GPP TS 29.571 [6] |
NR Cell Identifier |
Uint16 |
3GPP TS 29.571 [6] |
|
5Qi |
3GPP TS 29.571 [6] |
5G QoS Identifier |
CorrelationID |
3GPP TS 29.572 [25] |
LCS Correlation ID |
Pei |
3GPP TS 29.571 [6] |
|
Dnn |
3GPP TS 29.571 [6] |
|
Gpsi |
3GPP TS 29.571 [6] |
|
GroupId |
3GPP TS 29.571 [6] |
|
PlmnId |
3GPP TS 29.571 [6] |
|
RfspIndex |
3GPP TS 29.571 [6] |
|
EbiArpMapping |
3GPP TS 29.502 [16] |
EBI – ARP mapping |
NsiId |
3GPP TS 29.531 [18] |
|
TraceData |
3GPP TS 29.571 [6] |
Trace control and configuration parameters |
ConfiguredSnssai |
3GPP TS 29.531 [18] |
|
NgApCause |
3GPP TS 29.571 [6] |
Represents the NG AP cause IE |
Area |
3GPP TS 29.571 [6] |
|
ServiceAreaRestriction |
3GPP TS 29.571 [6] |
|
CoreNetworkType |
3GPP TS 29.571 [6] |
|
Ambr |
3GPP TS 29.571 [6] |
|
SliceMbr |
3GPP TS 29.571 [6] |
|
GlobalRanNodeId |
3GPP TS 29.571 [6] |
|
NfGroupId |
3GPP TS 29.571 [6] |
Network Function Group Id |
DurationSec |
3GPP TS 29.571 [6] |
|
StnSr |
3GPP TS 29.571 [6] |
Session Transfer Number for SRVCC |
CMsisdn |
3GPP TS 29.571 [6] |
Correlation MSISDN |
DateTime |
3GPP TS 29.571 [6] |
|
SmallDataRateStatus |
3GPP TS 29.571 [6] |
|
NfSetId |
3GPP TS 29.571 [13] |
NF Set ID |
NfServiceSetId |
3GPP TS 29.571 [13] |
NF Service Set ID |
LMFIdentification |
3GPP TS 29.572 [25] |
LMF Identification |
PlmnAssiUeRadioCapId |
3GPP TS 29.571 [6] |
|
ManAssiUeRadioCapId |
3GPP TS 29.571 [6] |
|
NrV2xAuth |
3GPP TS 29.571 [6] |
NR V2X services authorized |
LteV2xAuth |
3GPP TS 29.571 [6] |
LTE V2X services authorized |
BitRate |
3GPP TS 29.571 [6] |
Bit Rate |
Pc5QoSPara |
3GPP TS 29.571 [6] |
PC5 QoS parameters |
PduSessionInfo |
3GPP TS 29.571 [6] |
The Slice and DNN combination of a PDU session. |
PcfUeCallbackInfo |
3GPP TS 29.571 [6] |
The callback information of the PCF for the UE to allow the PCF for the PDU session to send SM Policy Association Establishment and Termination events notification. |
CnAssistedRanPara |
3GPP TS 29.502 [16] |
SMF derived CN assisted RAN Parameters Tuning |
MoExpDataCounter |
3GPP TS 29.571 [6] |
MO Exception Data Counter |
CagData |
3GPP TS 29.503 [35] |
Closed Access Group Data |
NssaaStatus |
3GPP TS 29.571 [6] |
Subscribed S-NSSAI subject to NSSAA procedure and the status |
JobType |
3GPP TS 29.571 [6] |
Job Type in the trace |
MeasurementLteForMdt |
3GPP TS 29.571 [6] |
Measurements used for MDT in LTE in the trace |
MeasurementNrForMdt |
3GPP TS 29.571 [6] |
Measurements used for MDT in NR in the trace |
ReportingTrigger |
3GPP TS 29.571 [6] |
Reporting Triggers for MDT in the trace |
ReportIntervalMdt |
3GPP TS 29.571 [6] |
Report Interval for MDT in LTE in the trace |
ReportAmountMdt |
3GPP TS 29.571 [6] |
Report Amount for MDT in the trace |
CollectionPeriodRmmLteMdt |
3GPP TS 29.571 [6] |
Collection period for RRM measurements LTE for MDT in the trace |
MeasurementPeriodLteMdt |
3GPP TS 29.571 [6] |
Measurement period LTE for MDT in the trace in |
AreaScope |
3GPP TS 29.571 [6] |
Area Scope |
PositioningMethodMdt |
3GPP TS 29.571 [6] |
Positioning Method for MDT in the trace in LTE |
ReportIntervalNrMdt |
3GPP TS 29.571 [6] |
Report Interval for MDT in NR in the trace |
CollectionPeriodRmmNrMdt |
3GPP TS 29.571 [6] |
Collection period for RRM measurements NR for MDT in the trace |
SensorMeasurement |
3GPP TS 29.571 [6] |
Sensor information for MDT in the trace |
ScheduledCommunicationTime |
3GPP TS 29.571 [6] |
Scheduled Communication Time |
StationaryIndication |
3GPP TS 29.571 [6] |
Stationary Indication |
TrafficProfile |
3GPP TS 29.571 [6] |
Traffic Profile |
BatteryIndication |
3GPP TS 29.571 [6] |
Battery Indication |
NFType |
3GPP TS 29.510 [29] |
NF type |
UeAuth |
3GPP TS 29.571 [6] |
UE authorisation for PC5 service |
PartitioningCriteria |
3GPP TS 29.571 [6] |
Partitioning Criteria |
RedirectResponse |
3GPP TS 29.571 [6] |
Response body of the redirect response message. |
CagId |
3GPP TS 29.571 [6] |
CAG ID |
NnwdafEventsSubscription |
3GPP TS 29.520 [52] |
Represents an Individual NWDAF Event Subscription resource |
PresenceInfo |
3GPP TS 29.571 [6] |
|
UePositioningCapabilities |
3GPP TS 29.572 [25] |
Indicates the positioning capabilities supported by the UE. |
SmfSelectionData |
3GPP TS 29.507 [32] |
|
EpsInterworkingInfo |
3GPP TS 29.503 [35] |
|
IpAddress |
3GPP TS 29.503 [35] |
|
Fqdn |
3GPP TS 29.571 [6] |
|
PresenceState |
3GPP TS 29.571 [6] |
Presence State |
6.1.6.2 Structured data types
6.1.6.2.1 Introduction
Structured data types used in Namf_Communication service are specified in this clause.
6.1.6.2.2 Type: SubscriptionData
Table 6.1.6.2.2-1: Definition of type SubscriptionData
Attribute name |
Data type |
P |
Cardinality |
Description |
amfStatusUri |
Uri |
M |
1 |
This IE shall include the callback URI to receive notification of AMF status change. |
guamiList |
array(Guami) |
C |
1..N |
This IE shall be absent for subscribing to status change for any GUAMI supported by the AMF, it shall be present for subscribing to specific GUAMIs supported by the AMF. |
6.1.6.2.3 Type: AmfStatusChangeNotification
Table 6.1.6.2.3-1: Definition of type AmfStatusChangeNotification
Attribute name |
Data type |
P |
Cardinality |
Description |
amfStatusInfoList |
array(AmfStatusInfo) |
M |
1..N |
This IE shall contain the status change information about the AMF |
6.1.6.2.4 Type: AmfStatusInfo
Table 6.1.6.2.4-1: Definition of type AmfStatusInfo
Attribute name |
Data type |
P |
Cardinality |
Description |
guamiList |
array(Guami) |
M |
1..N |
This IE shall contain the GUAMIs |
statusChange |
StatusChange |
M |
1 |
This IE shall contain the Status change of the related GUAMIs |
targetAmfRemoval |
AmfName |
C |
0..1 |
This IE shall contain the AMF Name of the target AMF in the AMF planned removal without UDSF scenario |
targetAmfFailure |
AmfName |
C |
0..1 |
This IE shall contain the AMF Name of the target AMF in the AMF Auto-recovery without UDSF scenario. |
6.1.6.2.5 Type: AssignEbiData
Table 6.1.6.2.5-1: Definition of type AssignEbiData
Attribute name |
Data type |
P |
Cardinality |
Description |
Applicability |
pduSessionId |
PduSessionId |
M |
1 |
Represents the identifier of the PDU Session requesting EBI(s) to be assigned. |
|
arpList |
array(Arp) |
C |
1..N |
This IE shall be present if the NF Service Consumer (e.g SMF) requests the AMF to assign EBI(s) for the PDU session. When present, this IE shall contain the list of ARP(s)of the QoS flow(s) for which EBI(s) are requested. |
|
releasedEbiList |
array(EpsBearerId) |
C |
1..N |
This IE shall be present if the NF Service Consumer (e.g. SMF) needs to release the assigned EBI(s) from QoS flows (e.g. when the QoS flow is released). |
|
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]). |
|
modifiedEbiList |
array(EbiArpMapping) |
C |
1..N |
This IE shall be present if a PDU session modification procedure resulted in the change of ARP for a QoS flow to which an EBI is already allocated. |
EAEA |
6.1.6.2.6 Type: AssignedEbiData
Table 6.1.6.2.6-1: Definition of type AssignedEbiData
Attribute name |
Data type |
P |
Cardinality |
Description |
Applicability |
pduSessionId |
PduSessionId |
M |
1 |
Represents the identifier of the PDU Session requesting EBI(s) to be assigned. |
|
assignedEbiList |
array(EbiArpMapping) |
M |
0..N |
This IE shall be present if the AMF assigned the requested EBI(s). This IE shall contain the successfully assigned EBIs. (NOTE) |
|
failedArpList |
array(Arp) |
C |
1..N |
This IE shall be present if the AMF fails to allocate EBIs for a set of ARP(s). (NOTE) |
|
releasedEbiList |
array(EpsBearerId) |
C |
1..N |
This IE shall be present if the NF Service Consumer requested the release of EBI(s) or if the AMF revoked an already assigned EBI towards the same PDU session. This IE shall contain the list of EBI(s) released at the AMF. |
|
modifiedEbiList |
array(EpsBearerId) |
C |
1..N |
This IE shall be present if the NF Service Consumer requested to update the ARP for a QoS flow to which an EBI is already allocated. This IE shall contain the list of EBI(s) whose ARP has been updated at the AMF. |
EAEA |
NOTE: The same ARP value may be returned in the assignedEbiList and in the failedArpList, if the request included the same ARP value more than once in the arpList and the AMF is not able to allocate an EBI for every occurrence of this ARP value. |
6.1.6.2.7 Type: AssignEbiFailed
Table 6.1.6.2.7-1: Definition of type AssignEbiFailed
Attribute name |
Data type |
P |
Cardinality |
Description |
pduSessionId |
PduSessionId |
M |
1 |
Represents the identifier of the PDU Session requesting EBI(s) to be assigned. |
failedArpList |
array(Arp) |
C |
1..N |
This IE shall be present if the AMF fails to allocate EBIs for a set of ARPs. |
6.1.6.2.8 Type: UEContextRelease
Table 6.1.6.2.8-1: Definition of type UEContextRelease
Attribute name |
Data type |
P |
Cardinality |
Description |
supi |
Supi |
C |
0..1 |
This IE shall be present if the UE is emergency registered and the SUPI is not authenticated. |
unauthenticatedSupi |
boolean |
C |
0..1 |
When present, this IE shall be set as follows: – true: unauthenticated SUPI; – false (default): authenticated SUPI. This IE shall be present if the SUPI is present in the message but is not authenticated and is for an emergency registered UE. |
ngapCause |
NgApCause |
M |
1 |
This IE shall contain the cause value received from the source 5G-AN in the handover Cancel message received over the NGAP interface. |
6.1.6.2.9 Type: N2InformationTransferReqData
Table 6.1.6.2.9-1: Definition of type N2InformationTransferReqDataTransfer
Attribute name |
Data type |
P |
Cardinality |
Description |
taiList |
array(Tai) |
C |
1..N |
This IE shall be included if the N2 information needs to be sent to the 5G-AN nodes that serve the list of tracking areas provided. |
ratSelector |
RatSelector |
C |
0..1 |
This IE shall be included to indicate if the N2 information shall be transferred to ng-eNBs or gNBs exclusively. |
globalRanNodeList |
array(GlobalRanNodeId) |
C |
1..N |
This IE shall be included if the N2 information needs to be sent to the list of RAN nodes provided. |
n2Information |
N2InfoContainer |
M |
1 |
This IE includes the information to be sent on the N2 interface to the identified 5G-AN nodes and additional information required for the processing of the message by the AMF. |
supportedFeatures |
SupportedFeatures |
C |
0..1 |
This IE shall be present if at least one optional feature defined in clause 6.1.8 is supported. |
6.1.6.2.10 Type: NonUeN2InfoSubscriptionCreateData
Table 6.1.6.2.10-1: Definition of type NonUeN2InfoSubscriptionCreateData
Attribute name |
Data type |
P |
Cardinality |
Description |
globalRanNodeList |
array(GlobalRanNodeId)) |
C |
1..N |
This IE shall be included if the subscription is for N2 information from RAN node(s) for which the N2 information notification is subscribed (i.e N3IWF identifier or gNB identifier or Ng-eNB identifier). (NOTE) |
anTypeList |
array(AccessType) |
C |
1..N |
This IE shall be included, if the globalRanNodeId IE is not included and if the N2 information from a specific access network needs to be subscribed. When included this IE shall contain the access type of the access network from which Non UE specific N2 information is to be notified. (NOTE) |
n2InformationClass |
N2InformationClass |
M |
1 |
This IE represents the class of N2 information that the NF Service Consumer requires to be notified. |
n2NotifyCallbackUri |
Uri |
M |
1 |
This IE represents the callback URI on which the N2 information shall be notified. |
nfId |
NfInstanceId |
C |
0..1 |
This IE shall be present if the subscription is for "NRPPa" N2 information class and/or "LPP" N1 information class. When present, this IE shall carry the value to be used for NGAP "Routing ID" IE, which identifies the Network Function (e.g. LMF) instance handling the NRPPa and/or LPP data. This IE may also be present if the subscription is for "PWS" N2 information class. When present, this IE shall carry the instance identity of the network function (e.g. CBCF or PWS-IWF) creating the subscription. |
supportedFeatures |
SupportedFeatures |
C |
0..1 |
This IE shall be present if at least one optional feature defined in clause 6.1.8 is supported. |
NOTE: Absence of both IEs means the subscription is for N2 information from all connected Access Network node(s) via any access type. |
6.1.6.2.11 Type: NonUeN2InfoSubscriptionCreatedData
Table 6.1.6.2.11-1: Definition of type NonUeN2InfoSubscriptionCreatedData
Attribute name |
Data type |
P |
Cardinality |
Description |
n2NotifySubscriptionId |
string |
M |
1 |
Represents the Id created by the AMF for the subscription to notify a non-UE related N2 information. |
supportedFeatures |
SupportedFeatures |
C |
0..1 |
This IE shall be present if at least one optional feature defined in clause 6.1.8 is supported. |
n2InformationClass |
N2InformationClass |
O |
0..1 |
This IE represents the class of N2 information that the NF Service Consumer subscribed to. |
6.1.6.2.12 Type: UeN1N2InfoSubscriptionCreateData
Table 6.1.6.2.12-1: Definition of type UeN1N2InfoSubscriptionCreateData
Attribute name |
Data type |
P |
Cardinality |
Description |
n2InformationClass |
N2InformationClass |
C |
0..1 |
This IE shall be present if the NF service consumer subscribes for a N2 information notification. This IE represents the class of N2 information that the NF Service Consumer requires to be notified. |
n2NotifyCallbackUri |
Uri |
C |
0..1 |
This IE shall be present if the NF service consumer subscribes for a N2 information notification. This IE represents the callback URI on which the N2 information shall be notified. |
n1MessageClass |
N1MessageClass |
C |
0..1 |
This IE shall be present if the NF service consumer subscribes for a N1 message notification. This IE represents the class of N1 message that the NF Service Consumer requires to be notified. |
n1NotifyCallbackUri |
Uri |
C |
0..1 |
This IE shall be present if the NF service consumer subscribes for a N1 message notification. This IE represents the callback URI on which the N1 message shall be notified. |
nfId |
NfInstanceId |
C |
0..1 |
This IE shall be present if the subscription is for "NRPPa" N2 information class and/or "LPP" N1 information class. When present, this IE shall carry the value to be used for NGAP "Routing ID" IE, which identifies the Network Function (e.g. LMF) instance handling the NRPPa and/or LPP data. |
supportedFeatures |
SupportedFeatures |
C |
0..1 |
This IE shall be present if at least one optional feature defined in clause 6.1.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.1.6.2.13 Type: UeN1N2InfoSubscriptionCreatedData
Table 6.1.6.2.13-1: Definition of type UeN1N2InfoSubscriptionCreatedData
Attribute name |
Data type |
P |
Cardinality |
Description |
n1n2NotifySubscriptionId |
string |
M |
1 |
Represents the Id created by the AMF for the subscription to notify a UE related N1/N2 information. |
supportedFeatures |
SupportedFeatures |
C |
0..1 |
This IE shall be present if at least one optional feature defined in clause 6.1.8 is supported. |
6.1.6.2.14 Type: N2InformationNotification
Table 6.1.6.2.14-1: Definition of type N2InformationNotification
Attribute name |
Data type |
P |
Cardinality |
Description |
Applicability |
n2NotifySubscriptionId |
string |
M |
1 |
Represents the subscription Id for which the notification is generated. The NF Service Consumer uses this to co-relate the notification against a corresponding subscription. If the notification is due to an implicit subscription via NRF, then the value shall be set as "implicit". During the AMF planned removal procedure with UDSF deployed procedure, this IE shall be set to "" (empty string) and be ignored by the NF Service Consumer. |
|
n2InfoContainer |
N2InfoContainer |
C |
0..1 |
This IE shall be present, except during Inter NG-RAN node N2 based handover procedure (see clause 5.2.2.3.6.2). When present, this IE shall contain the N2 information related to the corresponding N2 information class. |
|
toReleaseSessionList |
array(PduSessionId) |
C |
1..N |
This IE shall be present during N2 based handover procedure, if there are any PDU session(s) associated with Network Slice(s) which become no longer available. When present, this IE shall include all the PDU session(s) associated with no longer available S-NSSAI(s). |
|
lcsCorrelationId |
CorrelationID |
C |
0..1 |
This IE shall be present, if an LCS correlation identifier is received in corresponding N1/N2 Message Transfer service operation. When present, this IE shall carry the LCS correlation identifier. |
|
notifyReason |
N2InfoNotifyReason |
C |
0..1 |
This IE shall be present, if "n2InfoContainer" attribute is not present; this IE may be present otherwise. When present, this IE indicates the reason for the N2 information notification. |
|
smfChangeInfoList |
array(SmfChangeInfo) |
C |
1..N |
This IE shall be present during N2 based handover procedure, if there is I-SMF or V-SMF change or removal for the related PDU session(s). When present, this IE shall indicate the I-SMF/V-SMF situation after successful HO complete. |
DTSSA |
ranNodeId |
GlobalRanNodeId |
C |
0..1 |
This IE shall be present during the AMF planned removal procedure with UDSF deployed procedure. When present, it shall contain the Global RAN Node ID. The IE shall contain either the gNB ID or the NG-eNB ID. |
|
initialAmfName |
AmfName |
C |
0..1 |
This IE shall be present during the AMF planned removal procedure with UDSF deployed procedure. When present, it shall contain the AMF Name of the initial AMF. |
|
anN2IPv4Addr |
Ipv4Addr |
C |
0..1 |
This IE shall be present during the AMF planned removal procedure with UDSF deployed procedure, if the Access Network N2 interface is using IPv4 address. |
|
anN2IPv6Addr |
Ipv6Addr |
C |
0..1 |
This IE shall be present during the AMF planned removal procedure with UDSF deployed procedure, if the Access Network N2 interface is using IPv6 address. |
|
guami |
Guami |
C |
0..1 |
This IE shall be present during Location Services procedures (see clause 5.2.2.3.6.3) and it may be present otherwise. When present, it shall contain the GUAMI serving the UE. |
|
notifySourceNgRan |
boolean |
C |
0..1 |
This IE shall be present during an Inter NG-RAN node N2 based DAPS handover procedure , if the target AMF receives this indication in the Handover Notify from the target NG-RAN node (see clause 4.9.1.3.3a of 3GPP TS 23.502 [3]). When present, it shall be set as follows: – true: Notify the Source NG-RAN about Handover Success – false (default): Do not notify the Source NG-RAN about Handover Success |
6.1.6.2.15 Type: N2InfoContainer
Table 6.1.6.2.15-1: Definition of type N2InfoContainer
Attribute name |
Data type |
P |
Cardinality |
Description |
Applicability |
n2InformationClass |
N2InformationClass |
M |
1 |
This IE represents the class of N2 information to be transferred. |
|
smInfo |
N2SmInformation |
C |
0..1 |
This IE shall be present if session management N2 information is to be transferred. When present, it represents a session management SMF related N2 information data part. |
|
ranInfo |
N2RanInformation |
C |
0..1 |
This IE shall be present if RAN related N2 information is to be transferred (i.e. n2InformationClass is "RAN"). When present, it shall contain the RAN related N2 information data part. |
|
nrppaInfo |
NrppaInformation |
C |
0..1 |
This IE shall be present if location service related N2 information is to be transferred. When present, it represents a NRPPa related N2 information data part. |
|
pwsInfo |
PwsInformation |
C |
0..1 |
This IE shall be present if PWS related N2 information is to be transferred. |
|
v2xInfo |
V2xInformation |
C |
0..1 |
This IE shall be present if V2X related N2 information is to be transferred. |
|
proseInfo |
ProSeInformation |
C |
0..1 |
This IE shall be present if 5G ProSe related N2 information is to be transferred. |
ProSe |
6.1.6.2.16 Type: N1MessageNotification
Table 6.1.6.2.16-1: Definition of type N1MessageNotification
Attribute name |
Data type |
P |
Cardinality |
Description |
n1NotifySubscriptionId |
string |
C |
0..1 |
Represents the subscription Id for which the notification is generated. The NF Service Consumer uses this to correlate the notification against a corresponding subscription. If the notification is due to an implicit subscription via NRF, then the value shall be set as "implicit". This IE shall be present if the notification is based on a subscription to N1MessgeNotification. An exception is for the case when initial AMF forwards NAS message to target AMF during AMF re-allocation procedure. |
n1MessageContainer |
N1MessageContainer |
M |
1 |
Contains the N1 message class and N1 message content. |
lcsCorrelationId |
CorrelationID |
O |
0..1 |
If the N1 message notified is for LCS procedures, the NF Service Producer (e.g. AMF) may include an LCS correlation identifier. |
registrationCtxtContainer |
RegistrationContextContainer |
C |
0..1 |
If the N1 message notified is of type 5GMM (i.e. during Registration with AMF re-allocation procedure), the NF Service Producer (e.g. AMF) shall include this IE, if available. |
newLmfIdentification |
LMFIdentification |
O |
0..1 |
If a new LMF is selected by AMF, this IE may include the new selected LMF Identification. |
guami |
Guami |
C |
0..1 |
This IE shall be present during UE Assisted and UE Based Positioning Procedure (see clause 5.2.2.3.5.3) or the LCS Event Report, Event Reporting in RRC INACTIVE state procedures, LCS Cancel Location and LCS Periodic-Triggered Invoke Procedures (see clause 5.2.2.3.5.5) and it may be present otherwise. When present, it shall contain the GUAMI serving the UE. |
cIoT5GSOptimisation |
boolean |
C |
0..1 |
This IE shall be present when the N1 message class is "LPP/LCS" and the N1 message is received from the UE with Control Plane CIoT 5GS Optimisation. When present, it shall be set as follows: – true: Control Plane CIoT 5GS Optimisation was used and no signalling or data is currently pending for the UE at the AMF. – false (default): Control Plane CIoT 5GS Optimisation was not used or signalling or data is currently pending for the UE at the AMF. |
ecgi |
Ecgi |
O |
0..1 |
When present, this IE shall indicate the identifier of the E-UTRAN cell serving the UE. This IE may be present if the N1 message notified is for LCS procedures. |
ncgi |
Ncgi |
O |
0..1 |
When present, this IE shall indicate the identifier of the NR cell serving the UE. This IE may be present if the N1 message notified is for LCS procedures. |
6.1.6.2.17 Type: N1MessageContainer
Table 6.1.6.2.17-1: Definition of type N1MessageContainer
Attribute name |
Data type |
P |
Cardinality |
Description |
n1MessageClass |
N1MessageClass |
M |
1 |
This IE shall contain the N1 message class for the message content specified in n1MessageContent. |
n1MessageContent |
RefToBinaryData |
M |
1 |
This IE shall reference the N1 message binary data corresponding to the n1MessageClass. See 3GPP TS 24.501 [11]. See clause 6.1.6.4.2. |
nfId |
NfInstanceId |
C |
0..1 |
This IE shall be present when the n1MessageClass IE is set to "LPP" or "LCS". It should be present when the n1MessageClass IE is set to "SM". It may be present otherwise. When present, this IE shall carry the identifier of the Network Function (e.g. LMF or SMF) instance sending the N1 message. (NOTE) |
serviceInstanceId |
string |
O |
0..1 |
When present, this IE shall carry the Service Instance Identifier of the Service Instance (e.g. LMF) sending the N1 message. |
NOTE: For a Home-routed PDU session, this IE shall carry the NF instance ID of the V-SMF; for a PDU session with I-SMF, this IE shall carry the NF instance ID of the I-SMF. |
6.1.6.2.18 Type: N1N2MessageTransferReqData
Table 6.1.6.2.18-1: Definition of type N1N2MessageTransferReqData
Attribute name |
Data type |
P |
Cardinality |
Description |
Applicability |
n1MessageContainer |
N1MessageContainer |
C |
0..1 |
This IE shall be included if a N1 message needs to be transferred. |
|
n2InfoContainer |
N2InfoContainer |
C |
0..1 |
This IE shall be included if a N2 information needs to be transferred. |
|
mtData |
RefToBinaryData |
C |
0..1 |
This IE shall be included if mobile terminated data (i.e. CIoT user data container) needs to be transferred. When present, it shall reference the mobile terminated data (see clause 6.1.6.4.4). |
CIOT |
skipInd |
boolean |
C |
0..1 |
This IE shall be present and set to "true" if the service consumer (e.g. SMF) requires the N1 message to be sent to the UE only when UE is in CM-CONNECTED, e.g. during SMF initiated PDU session release procedure (see clause 4.3.4.2 of 3GPP TS 23.502 [3]). When present, this IE shall be set as following: – true: AMF should skip sending N1 message to UE, when the UE is in CM-IDLE. – false (default): the AMF shall send the N1 message to the UE. |
|
lastMsgIndication |
boolean |
O |
0..1 |
This flag when present shall indicate that the message transferred is the last message. (See clause 4.13.3.3 and clause 4.13.3.6 of 3GPP TS 23.502 [3]. |
|
pduSessionId |
PduSessionId |
O |
0..1 |
PDU Session ID for which the N1 / N2 message is sent, if the N1 / N2 message class is SM. |
|
lcsCorrelationId |
CorrelationID |
O |
0..1 |
LCS Correlation ID, for which the N1/N2 message is sent, if – the N1 message class is LPP (see clause 6.11.1 of 3GPP TS 23.273 [42]) or LCS (see clause 6.3 of 3GPP TS 23.273 [42]); and/or – the N2 Information class is NRPPa (see clause 6.11.2 of 3GPP TS 23.273 [42]). |
|
ppi |
Ppi |
O |
0..1 |
This IE when present shall indicate the Paging policy to be applied. The paging policies are configured at the AMF. |
|
arp |
Arp |
O |
0..1 |
This IE when present shall indicate the Allocation and Retention Priority of the PDU session for which the N1/N2 message transfer is initiated. To support priority paging, the AMF shall use this IE to determine whether to include the Paging Priority IE in the NGAP Paging Message (see clause 5.4.3.3 of 3GPP TS 23.501 [2]). The set of ARP values associated with priority paging and mapping to Paging Priority IE values are configured at the AMF. This IE shall not be present when the N1/N2 message class is not SM. |
|
5qi |
5Qi |
O |
0..1 |
This IE when present shall indicate the 5QI associated with the PDU session for which the N1 / N2 message transfer is initiated. This IE shall not be present when the N1/N2 message class is not SM. |
|
n1n2FailureTxfNotifURI |
Uri |
O |
0..1 |
If included, this IE represents the callback URI on which the AMF shall notify the N1/N2 message transfer failure. |
|
smfReallocationInd |
boolean |
O |
0..1 |
This IE shall indicate that the SMF is requested to be reallocated (see clause 4.3.5.2 of 3GPP TS 23.502 [3]). When present, this IE shall be set as follows: – true: the SMF is requested to be reallocated. – false (default): the SMF is not requested to be reallocated. |
|
areaOfValidity |
AreaOfValidity |
O |
0..1 |
This IE represents the list of TAs where the provided N2 information is valid. See clause 5.2.2.2.7 and 4.2.3.3 of 3GPP TS 23.502 [3]. |
|
supportedFeatures |
SupportedFeatures |
C |
0..1 |
This IE shall be present if at least one optional feature defined in clause 6.1.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]). |
|
maAcceptedInd |
boolean |
C |
0..1 |
This IE shall be present if a request to establish a MA PDU session was accepted or if a single access PDU session was upgraded into a MA PDU session (see clauses 4.22.2 and 4.22.3 of 3GPP TS 23.502 [3]). When present, it shall be set as follows: – true: MA PDU session – false (default): single access PDU session |
MAPDU |
extBufSupport |
boolean |
O |
0..1 |
This IE may be present with value "true" if Extended Buffering is permitted, during Network triggered Service Request Procedure (see clause 4.2.3.3 of 3GPP TS 23.502 [3]), UPF anchored Mobile Terminated Data Transport in Control Plane CIoT 5GS Optimisation procedure (see clause 4.24.2 of 3GPP TS 23.502 [3]) or NEF Anchored Mobile Terminated Data Transport (see clause 4.25.5 of 3GPP TS 23.502 [3]). When present, this IE shall indicate whether Extended Buffering applies or not: – true: Extended Buffering applies – false (default) Extended Buffering does not apply |
|
targetAccess |
AccessType |
C |
0..1 |
This IE shall be included by a SMF for a MA PDU session to indicate the target access type (i.e. 3GPP access or Non-3GPP access) towards which the N2 information and optionally N1 information is requested to be sent. This IE may be included by an LMF to indicate the access type through which an LPP message shall be transmitted to the UE. This IE shall be included by an SMF and set to the old access type during an intra-AMF handover between 3GPP and non-3GPP accesses, when releasing the N2 PDU session resources in the old access. |
MAPDU ELCS 3GA-N3GA-HO |
nfId |
NfInstanceId |
C |
0..1 |
This IE should be included by the SMF when invoking N1N2MessageTransfer service operation, if the n1MessageContainer IE is not present. When present, this IE shall carry the identifier of the NF instance invoking the service operation, i.e. the SMF instance hosting the SM Context for the PDU session. (NOTE 3) |
|
NOTE 1: For N1 message class "UPDP", as per 3GPP TS 24.501 [11] Annex D, the messages between UE and PCF carry PTI which is used by the PCF to correlate the received N1 message in the notification with a prior transaction initiated by the PCF. NOTE 2: During Downlink Data Notification procedure, if the SMF receives the PPI value (=DSCP(0..63)) from the UPF and wants to set the PPI value in the N1N2MessgeTransfer message, the SMF shall map the PPI value received from N4 message to correct PPI value (0..7) used in N11 message. NOTE 3: If the n1MessageContainer IE is present, the nfId attribute in the n1MessageContainer IE should be used by the SMF and the AMF to identify the NF instance ID of the sending SMF. |
6.1.6.2.19 Type: N1N2MessageTransferRspData
Table 6.1.6.2.19-1: Definition of type N1N2MessageTransferRspData
Attribute name |
Data type |
P |
Cardinality |
Description |
cause |
N1N2MessageTransferCause |
M |
1 |
This IE shall provide the result of the N1/N2 message transfer processing at the AMF. |
supportedFeatures |
SupportedFeatures |
C |
0..1 |
This IE shall be present if at least one optional feature defined in clause 6.1.8 is supported. |
6.1.6.2.20 Type: RegistrationContextContainer
Table 6.1.6.2.20-1: Definition of type RegistrationContextContainer
Attribute name |
Data type |
P |
Cardinality |
Description |
ueContext |
UeContext |
M |
1 |
This IE shall contain the UE Context information. |
localTimeZone |
TimeZone |
O |
0..1 |
This IE contains the time zone UE is currently located. |
anType |
AccessType |
M |
1 |
This IE shall contain the current access type of the UE. |
anN2ApId |
integer |
M |
1 |
This IE shall contain the RAN UE NGAP ID over N2 interface. |
ranNodeId |
GlobalRanNodeId |
M |
1 |
This IE shall contain the Global RAN Node ID. The IE shall contain either the gNB ID or the NG-eNB ID. |
initialAmfName |
AmfName |
M |
1 |
This IE shall contain the AMF Name of the initial AMF. |
userLocation |
UserLocation |
M |
1 |
This IE shall contain the user location received from 5G-AN. |
anN2IPv4Addr |
Ipv4Addr |
C |
0..1 |
If the Access Network N2 interface is using IPv4 address, this IE shall be included. |
anN2IPv6Addr |
Ipv6Addr |
C |
0..1 |
If the Access Network N2 interface is using IPv6 address, this IE shall be included. |
rrcEstCause |
string |
C |
0..1 |
This IE shall contain the RRC Establishment Cause, if received from the 5G-AN (See 3GPP TS 38.413 [12], clause 9.2.5.1). It carries the value in hexadecimal representation Pattern: ‘^[0-9a-fA-F]+$’ |
ueContextRequest |
boolean |
C |
0..1 |
This IE shall contain the indication on whether UE context including security information needs to be setup at the NG-RAN, if received from the NG-RAN by the initial AMF (See 3GPP TS 38.413 [12], clause 9.2.5.1). When present, it shall be set as follows: – true: UE context including security information needs to be setup at the NG-RAN. – false (default): UE context including security information does not need to be setup at the NG-RAN. |
initialAmfN2ApId |
integer |
C |
0..1 |
This IE shall contain the AMF UE NGAP ID of the initial AMF over N2 interface, if available. |
allowedNssai |
AllowedNssai |
O |
0..1 |
This IE contains the allowed NSSAI of the UE. This IE also contains the mapped home network S-NSSAI for each allowed S-NSSAI. |
configuredNssai |
array(ConfiguredSnssai) |
O |
1..N |
This IE shall contain the configured S-NSSAI(s) authorized by the NSSF in the serving PLMN, if received from the NSSF. |
rejectedNssaiInPlmn |
array(Snssai) |
O |
1..N |
This IE shall contain the rejected NSSAI in the PLMN, if received from the NSSF. |
rejectedNssaiInTa |
array(Snssai) |
O |
1..N |
This IE shall contain the rejected NSSAI in the current TA, if received from the NSSF. |
selectedPlmnId |
PlmnId |
O |
0..1 |
This IE shall contain the selected PLMN Id for the non-3GPP access, if received from the 5G-AN (See 3GPP TS 38.413 [12], clause 9.2.5.1). |
iabNodeInd |
boolean |
O |
0..1 |
This IE shall contain the IAB Node Indication, if received from the 5G-AN (See 3GPP TS 38.413 [12], clause 9.2.5.1). When present, it shall be set as follows: – true: 5G-AN is an IAB Node. – false (default): 5G-AN is not an IAB Node. |
ceModeBInd |
CeModeBInd |
O |
0..1 |
This IE shall contain the CE-mode-B Support Indicator, if received from the 5G-AN (See 3GPP TS 38.413 [12], clause 9.2.5.1). |
lteMInd |
LteMInd |
O |
0..1 |
This IE shall contain the LTE-M Indication, if received from the 5G-AN (See 3GPP TS 38.413 [12], clause 9.2.5.1). |
authenticatedInd |
boolean |
O |
0..1 |
This IE shall contain the Authenticated Indication, if received from the 5G-AN (See 3GPP TS 38.413 [12], clause 9.2.5.1). This IE shall be set as follows: – true: authenticated by the 5G-AN; – false (default): unauthenticated by the 5G-AN. |
npnAccessInfo |
NpnAccessInfo |
O |
0..1 |
This IE shall contain the NPN Access Information, if received from the 5G-AN (See 3GPP TS 38.413 [12], clause 9.2.5.1). |
6.1.6.2.21 Type: AreaOfValidity
Table 6.1.6.2.21-1: Definition of type AreaOfValidity
Attribute name |
Data type |
P |
Cardinality |
Description |
taiList |
array(Tai) |
M |
0..N |
An array of TAI representing the area of validity of the associated N2 information provided. |
6.1.6.2.22 Void
6.1.6.2.23 Type: UeContextTransferReqData
Table 6.1.6.2.23-1: Definition of type UeContextTransferReqData
Attribute name |
Data type |
P |
Cardinality |
Description |
reason |
TransferReason |
M |
1 |
Indicate the reason for the UEContextTransfer service request |
accessType |
AccessType |
M |
1 |
This IE shall contain the access type of the UE. |
plmnId |
PlmnIdNid |
O |
0..1 |
If present, this IE shall contain the PLMN ID or SNPN ID of the NF service consumer (e.g target AMF). |
regRequest |
N1MessageContainer |
O |
0..1 |
If present, this IE shall refer to the registration request message which triggers the UE Context Transfer. The message class shall be "5GMM" and message content shall be reference to N1 Message Content binary data, See clause 6.1.6.4.2. |
supportedFeatures |
SupportedFeatures |
C |
0..1 |
This IE shall be present if at least one optional feature defined in clause 6.1.8 is supported. |
6.1.6.2.24 Type: UeContextTransferRspData
Table 6.1.6.2.24-1: Definition of type UeContextTransferRspData
Attribute name |
Data type |
P |
Cardinality |
Description |
Applicability |
ueContext |
UeContext |
M |
1 |
Represents an individual ueContext resource after the modification is applied. |
|
supportedFeatures |
SupportedFeatures |
C |
0..1 |
This IE shall be present if at least one optional feature defined in clause 6.1.8 is supported. |
|
ueRadioCapability |
N2InfoContent |
C |
0..1 |
This IE shall be included to contain the "UE Radio Capability Information" if available during context transfer procedure. UE Radio Capability Information does not include NB-IoT UE radio capability, see clause 5.4.4.1 of 3GPP TS 23.501 [2] |
|
ueRadioCapabilityForPaging |
N2InfoContent |
C |
0..1 |
This IE shall be included to contain the "UE Radio Capability for Paging" if available during context transfer procedure. |
|
ueNbiotRadioCapability |
N2InfoContent |
C |
0..1 |
This IE shall be included to contain "NB-IoT UE radio capability Information" if available during context transfer procedure, see clause 5.4.4.1 of 3GPP TS 23.501 [2] |
CIOT |
6.1.6.2.25 Type: UeContext
Table 6.1.6.2.25-1: Definition of type UeContext
Attribute name |
Data type |
P |
Cardinality |
Description |
Applicability |
supi |
Supi |
C |
0..1 |
This IE shall be present if available. When present, this IE contains SUPI of the UE. |
|
supiUnauthInd |
boolean |
C |
0..1 |
This IE shall be present if SUPI is present. When present, it shall indicate whether the SUPI is unauthenticated. |
|
gpsiList |
array(Gpsi) |
C |
1..N |
This IE shall be present if available and if it is not case b) specified in clause 5.2.2.2.1.1 step 2a. When present, this IE shall contain the GPSI(s) of the UE. |
|
pei |
Pei |
C |
0..1 |
This IE shall be present if available and if it is not case b) specified in clause 5.2.2.2.1.1 step 2a. When present, this IE shall contain Mobile Equipment Identity of the UE. |
|
udmGroupId |
NfGroupId |
O |
0..1 |
When present, it shall indicate the identity of the UDM Group serving the UE. |
|
ausfGroupId |
NfGroupId |
O |
0..1 |
When present, it shall indicate the identity of the AUSF Group serving the UE. |
|
pcfGroupId |
NfGroupId |
O |
0..1 |
When present, it shall indicate the identity of the PCF Group serving the UE. |
|
routingIndicator |
string |
O |
0..1 |
When present, it shall indicate the Routing Indicator of the UE. |
|
hNwPubKeyId |
integer |
O |
0..1 |
When present, it shall indicate the Home Network Public Key Identifier of the UE. (NOTE 4). |
|
groupList |
array(GroupId) |
C |
1..N |
This IE shall be present if the UE belongs to any subscribed internal group(s) and if it is not case b) specified in clause 5.2.2.2.1.1 step 2a. When present, this IE shall list the subscribed internal group(s) to which the UE belongs to. |
|
drxParameter |
DrxParameter |
C |
0..1 |
This IE shall be present if available and if it is not case b) specified in clause 5.2.2.2.1.1 step 2a. When present, this IE shall contain the DRX parameter of the UE. |
|
subRfsp |
RfspIndex |
C |
0..1 |
This IE shall be present if available and if it is not case b) specified in clause 5.2.2.2.1.1 step 2a. When present, it shall indicate the subscribed RFSP Index of the UE. |
|
usedRfsp |
RfspIndex |
C |
0..1 |
This IE shall be present if available and if it is not case b) specified in clause 5.2.2.2.1.1 step 2a. When present, it shall indicate the used RFSP Index of the UE. |
|
subUeAmbr |
Ambr |
C |
0..1 |
This IE shall be present if subscribed UE-AMBR has been retrieved from UDM and if it is not case b) specified in clause 5.2.2.2.1.1 step 2a. When present, this IE shall indicate the value of subscribed UE AMBR of the UE. |
|
subUeSliceMbrList |
map(SliceMbr) |
C |
1..N |
Map of SliceMbr, where the S-NSSAI shall be used as the key of the map. This IE shall be present if the list of subscribed UE-Slice-MBR(s) has been retrieved from UDM and if it is not case b) specified in clause 5.2.2.2.1.1 step 2a. When present, this IE shall indicate the list of subscribed UE-Slice-MBR(s) per S-NSSAI for the UE. |
|
smsfId |
NfInstanceId |
C |
0..1 |
This IE shall be present if the SMS service for UE is activated and if it is not case b) specified in clause 5.2.2.2.1.1 step 2a. When present, it indicates the identifier of the SMSF network function instance serving the UE. The NF service consumer (e.g. target AMF) may use this information to identify the SMSF NF service profile from among the SMSF NF service profiles it received from the NRF. |
|
seafData |
SeafData |
C |
0..1 |
This IE shall be present if available and if it is not case b) specified in clause 5.2.2.2.1.1 step 2a or the case specified in clause 5.2.2.2.1.2. When present, this IE contains the security data derived from data received from AUSF of the UE. |
|
5gMmCapability |
5GMmCapability |
C |
0..1 |
This IE shall be present if the UE had provided this IE during Registration Procedure and if it is not case b) specified in clause 5.2.2.2.1.1 step 2a. When present, this IE shall contain 5G MM capability of the UE. |
|
pcfId |
NfInstanceId |
C |
0..1 |
This IE shall be present if available and if it is not case b) specified in clause 5.2.2.2.1.1 step 2a. When present, this IE indicates the identity of the PCF for AM Policy and/or UE Policy. |
|
pcfSetId |
NfSetId |
C |
0..1 |
This IE shall be present, if available. When present, it shall contain the NF Set ID of the PCF for AM Policy and/or UE Policy. |
|
pcfAmpServiceSetId |
NfServiceSetId |
C |
0..1 |
This shall be present, if available. When present, it shall contain the NF Service Set ID of the PCF’s AM Policy service. |
|
pcfUepServiceSetId |
NfServiceSetId |
C |
0..1 |
This shall be present, if available. When present, it shall contain the NF Service Set ID of the PCF’s UE Policy service. |
|
pcfBindingLevel |
SbiBindingLevel |
C |
0..1 |
This IE shall be present if available. When present, this IE shall contain the SBI binding level of the PCF’s AM policy and UE Policy association resources. (NOTE 6) |
|
pcfAmPolicyUri |
Uri |
C |
0..1 |
This IE shall be present if available and if it is not case b) specified in clause 5.2.2.2.1.1 step 2a. When present this IE shall contain the URI of the individual AM policy resource (see 3GPP TS 29.507 [32] clause 5.3.3.2) used by the AMF. |
|
amPolicyReqTriggerList |
array(PolicyReqTrigger) |
C |
1..N |
This IE shall be present if available and if it is not case b) specified in clause 5.2.2.2.1.1 step 2a. When present this IE shall indicate the AM policy request triggers towards the PCF. The NF Service Consumer (e.g. target AMF) shall use these triggers to request AM policy from the PCF whenever these triggers are met. The possible AM policy control request triggers are specified in clause 6.1.2.5 of 3GPP TS 23.503 [7]. |
|
pcfUePolicyUri |
Uri |
C |
0..1 |
This IE shall be present if available and if it is not case b) specified in clause 5.2.2.2.1.1 step 2a. When present this IE shall contain the URI of the individual UE policy resource (see 3GPP TS 29.507 [32] clause 5.3.3.2) used by the AMF. |
|
uePolicyReqTriggerList |
array(PolicyReqTrigger) |
C |
1..N |
This IE shall be present if available and if it is not case b) specified in clause 5.2.2.2.1.1 step 2a. When present this IE shall indicate the UE policy request triggers towards the PCF. The NF Service Consumer (e.g. target AMF) shall use these triggers to request UE policy from the PCF whenever these triggers are met. The possible UE policy control request triggers are specified in clause 6.1.2.5 of 3GPP TS 23.503 [7]. |
|
hpcfId |
NfInstanceId |
O |
0..1 |
This IE indicates the identity of PCF for UE Policy in home PLMN, when the UE is roaming. |
|
hpcfSetId |
NfSetId |
O |
0..1 |
When present, this IE shall contain the NF Set ID of the PCF for UE Policy in home PLMN, when the UE is roaming. |
|
restrictedRatList |
array(RatType) |
O |
1..N |
When present, this IE shall indicate the list of RAT types that are restricted for the UE; see 3GPP TS 29.571 [6] (NOTE 1) |
|
forbiddenAreaList |
array(Area) |
O |
1..N |
When present, this IE shall indicate the list of forbidden areas of the UE. |
|
serviceAreaRestriction |
ServiceAreaRestriction |
O |
0..1 |
When present, this IE shall indicate subscribed Service Area Restriction for the UE. |
|
restrictedCnList |
array(CoreNetworkType) |
O |
1..N |
When present, this IE shall indicate the list of Core Network Types that are restricted for the UE. |
|
eventSubscriptionList |
array(ExtAmfEventSubscription) |
C |
1..N |
This IE shall be present if available and if it is not case b) specified in clause 5.2.2.2.1.1 step 2a. When present, it shall indicate the event subscription(s) targeting the UE or the group the UE is part of. If the source AMF supports binding procedures and if it received binding indications for event notifications (i.e. with "callback" scope) or for subscription change event notifications (i.e. with "subscription-events" scope) for certain subscriptions, these binding indications should also be included. If the source AMF knows the NF type of the NF that created the subscription, this information should also be indicated. |
|
mmContextList |
array(MmContext) |
C |
1..2 |
This IE shall be present if available and if it is not case b) specified in clause 5.2.2.2.1.1 step 2a. When present, this IE contains the MM Contexts of the UE. |
|
sessionContextList |
array(PduSessionContext) |
C |
1..N |
This IE shall be present if available and if it is neither case a) nor case b) specified in clause 5.2.2.2.1.1 step 2a. When present, this IE contains the PDU Session Contexts of the UE. (NOTE 2) |
|
epsInterworkingInfo |
EpsInterworkingInfo |
C |
0..1 |
This IE shall contain the associations between APN/DNN and PGW-C+SMF for EPS interworking, if available. |
|
traceData |
TraceData |
C |
0..1 |
This IE shall be present if signalling based trace has been activated (see 3GPP TS 32.422 [30]) and if it is not case b) specified in clause 5.2.2.2.1.1 step 2a. |
|
serviceGapExpiryTime |
DateTime |
C |
0..1 |
This IE shall be present if Service Gap Control is enabled and if the AMF has started a Service Gap Timer which has not expired yet (see clause 5.31.16 of 3GPP TS 23.501 [2]). The value of the IE shall indicate the expiry time of the active Service Gap Timer for the UE. |
|
stnSr |
StnSr |
O |
0..1 |
This IE shall be present if available, for UE supporting 5G-SRVCC (see clause 5.2.2.2.11 of 3GPP TS 23.502 [3]). When present, this IE contains STN-SR of the UE. |
|
cMsisdn |
CMsisdn |
O |
0..1 |
This IE shall be present if available, for UE supporting 5G-SRVCC (see clause 5.2.2.2.11 of 3GPP TS 23.502 [3]). When present, this IE contains C-MSISDN of the UE. |
|
msClassmark2 |
MSClassmark2 |
O |
0..1 |
This IE shall be present if available, for UE supporting 5G-SRVCC (see clause 5.2.2.2.11 of 3GPP TS 23.502 [3]). When present, this IE contains Mobile Station Classmark 2 of the UE. |
|
supportedCodecList |
array(SupportedCodec) |
O |
1..N |
This IE shall be present if available, for UE supporting 5G-SRVCC (see clause 5.2.2.2.11 of 3GPP TS 23.502 [3]). When present, this IE shall indicate the list of speech codecs supported by the UE. |
|
smallDataRateStatusInfos |
array(SmallDataRateStatusInfo) |
O |
1..N |
List of Small Data Rate Control Statuses for released PDU Sessions, see clause 5.31.14.3 of TS 23.501 [2]. |
CIOT |
restrictedPrimaryRatList |
array(RatType) |
O |
1..N |
When present, this IE shall indicate the list of RAT types that are restricted for use as primary RAT for the UE; see 3GPP TS 29.571 [6] (NOTE 1) |
|
restrictedSecondaryRatList |
array(RatType) |
O |
1..N |
When present, this IE shall indicate the list of RAT types that are restricted for use as secondary RAT for the UE; see 3GPP TS 29.571 [6] (NOTE 1) |
|
v2xContext |
V2xContext |
O |
0..1 |
This IE shall be present if available (see clause 6.5.4 of 3GPP TS 23.287 [47]). When present, this IE shall indicate the parameters related to the V2X services. |
|
lteCatMInd |
boolean |
C |
0..1 |
This IE shall be present with value "true" if the UE is a LTE Category M UE based on indication provided by the NG-RAN or by the MME at EPS to 5GS handover, as specified in 3GPP TS 23.502 [3]. When present, this IE shall be set as following: – true: the UE is a Category M UE – false (default): this UE is not a Category M UE. |
|
redCapInd |
boolean |
C |
0..1 |
This IE shall be present with value "true" if the UE is a NR RedCap UE based on indication provided by the NG-RAN, as specified in 3GPP TS 23.502 [3]. When present, this IE shall be set as following: – true: the UE is a NR RedCap UE – false (default): this UE is not a NR RedCap UE. |
|
moExpDataCounter |
MoExpDataCounter |
C |
0..1 |
This IE shall be present if a non-zero MO Exception counter has not been reported yet to SMF. When present, this IE shall contain the MO Exception Data Counter, as specified in clause 5.31.14.3 of 3GPP TS 23.501 [2]. |
|
cagData |
CagData |
O |
0..1 |
Closed Access Group Data When present, the provisioningTime attribute (from the CagData data type) shall be absent. |
NPN |
managementMdtInd |
boolean |
C |
0..1 |
This flag shall be present with value "true" if Management Based Minimization of Drive Tests (MDT) is allowed, as specified in 3GPP TS 32.422 [30]. When present, this IE shall be set as following: – true: management based MDT is allowed. – false (default): management based MDT is not allowed. |
|
immediateMdtConf |
ImmediateMdtConf |
C |
0..1 |
This IE shall be sent by the source AMF to the target AMF, if the Job Type indicates Immediate MDT. See clause 4.10 of 3GPP TS 32.422 [30]. |
|
ecRestrictionDataWb |
EcRestrictionDataWb |
C |
0..1 |
This IE shall be present if the AMF determines whether Enhanced Coverage is restricted or not for the UE for WB-N1 mode. If absent, this IE indicates Enhanced Coverage is not restricted for WB-N1 mode. (NOTE 3) |
|
ecRestrictionDataNb |
boolean |
C |
0..1 |
This IE shall be present if the AMF determines whether Enhanced Coverage is restricted or not for the UE for NB-N1 mode. If present, this IE shall indicate whether Enhanced Coverage for NB-N1 mode is restricted or not. – true: Enhanced Coverage for NB-N1 mode is restricted. – false or absent: Enhanced Coverage for NB-N1 mode is allowed. (NOTE 3) |
|
iabOperationAllowed |
boolean |
O |
0..1 |
This IE shall be present if the UE is allowed for IAB operation. It may be present otherwise. When present, it shall indicate whether the UE is allowed for IAB operation, as follows: – true: indicates that the UE is allowed for IAB operation. – false: indicates that the UE is not allowed for IAB operation. |
|
proseContext |
ProseContext |
O |
0..1 |
This IE shall be present if available (see clause 6.7 of 3GPP TS 23.304 [51]). When present, this IE shall indicate the parameters related to the ProSe services. |
ProSe |
analyticsSubscriptionList |
array(AnalyticsSubscription) |
C |
1..N |
This IE shall be present if the AMF has created analytics subscription(s) towards NWDAF related to the UE. If present, this IE shall include the list of analytics subscriptions, as specified in clauses 5.2.2.2.2 and 5.2.2.2.11 of 3GPP TS 23.502 [3]. |
|
pcfUepBindingInfo |
string |
C |
0..1 |
This IE shall be present if Binding Indication was received for UE Policy Association resource from the PCF. When present, this IE shall contain the Binding indication of the PCF’s UE Policy Association resource and shall be set to the value of the 3gpp-Sbi-Binding header defined in clause 5.2.3.2.6 of 3GPP TS 29.500 [4], without the header name. |
|
pcfAmpBindingInfo |
string |
C |
0..1 |
This IE shall be present if Binding Indication was received for AM Policy Association resource from the PCF. When present, this IE shall contain the Binding indications of the PCF’s AM policy Association resource and shall be set to the value of the 3gpp-Sbi-Binding header defined in clause 5.2.3.2.6 of 3GPP TS 29.500 [4], without the header name. |
|
usedServiceAreaRestriction |
ServiceAreaRestriction |
O |
0..1 |
When present, this IE shall include the Service Area Restriction from PCF. |
|
praInAmPolicy |
map(PresenceInfo) |
O |
1..N |
When present, this IE shall include the map of PRA Information for the subscribed "PRA_CHANGE" PolicyReqTrigger in the AM Policy Association. The key of the map shall be the "praId" attribute within the PresenceInfo data type. The "presenceState" attribute within the PresenceInfo data type shall not be supplied here. |
|
praInUePolicy |
map(PresenceInfo) |
O |
1..N |
When present, this IE shall include the map of PRA Information for the subscribed "PRA_CHANGE" PolicyReqTrigger in the UE Policy Association. The key of the map shall be the "praId" attribute within the PresenceInfo data type. The "presenceState" attribute within the PresenceInfo data type shall not be supplied here. |
|
updpSubscriptionData |
UpdpSubscriptionData |
O |
0..1 |
When present, this IE shall include the subscription resource in the AMF for a UE policy delivery related N1 message notification. |
|
smPolicyNotifyPduList |
array(PduSessionInfo) |
C |
1..N |
This IE shall be present if it has been received from the PCF for the UE, i.e. the PCF for the AM Policy Association and possibly the UE Policy Association. When present, this IE shall contain the information (Slice and DNN combination) of the PDU session(s) applicable for the notification of SM Policy Association Establishment and Termination events. (NOTE 5) |
SPAE |
pcfUeCallbackInfo |
PcfUeCallbackInfo |
C |
0..1 |
This IE shall be present if the smPolicyNotifyPduList IE is present. When present, this IE shall contain the callback information of the PCF for the UE to receive SM Policy Association Establishment and Termination events notification from the PCF for the SM Policy. (NOTE 5) |
SPAE |
uePositioningCap |
UePositioningCapabilities |
O |
0..1 |
When present, this IE shall indicate the positioning capabilities supported by the UE. |
|
snpnOnboardInd |
boolean |
C |
0..1 |
This IE shall be present if the UE is registered for onboarding in an SNPN. When present, it shall indicate the following: – true: indicates that the UE is registered for onboarding in an SNPN. – false (default): indicates that the UE is not registered for onboarding in an SNPN. |
eNPN |
astiDistributionIndication |
boolean |
O |
0..1 |
When present, this IE shall indicate whether the access stratum time distribution via Uu reference point should be activated or deactivated for the UE. When present, this IE shall be set as following: – true: ASTI distribution is activated for the UE. – false (default): ASTI distribution is deactivated for the UE. |
|
tsErrorBudget |
integer |
O |
0..1 |
When present, this IE shall indicate the Uu time synchronization error budget for the time synchronization service (as described in clause 5.27.1 in TS 23.501 [2]). It indicates the value in nano seconds. |
|
smfSelInfo |
SmfSelectionData |
C |
0..1 |
This IE shall be present if conditions for SMF Selection information replacement are received from the PCF for AM Policy. When present, It shall include the conditions for SMF selection information replacement, as determined by the PCF. |
|
pcfUeSliceMbrList |
map(SliceMbr) |
C |
1..N |
This IE shall be present when UE Slice MBR(s) were received from the PCF for AM Policy. When present, this IE shall include one or more UE-Slice-MBR(s) as determined by the PCF for allowed S-NSSAI(s). The key of the map is the S-NSSAI in the allowed NSSAI to which the UE-Slice-MBR belongs. |
|
smsfSetId |
NfSetId |
C |
0..1 |
This IE shall be present if available. When present, this IE shall contain the NF Set ID of the SMSF serving the UE. |
|
smsfServiceSetId |
NfServiceSetId |
C |
0..1 |
This shall be present, if available. When present, it shall contain the NF Service Set ID of the SMSF’s service instance serving the UE. |
|
smsfBindingInfo |
string |
C |
0..1 |
This IE shall be present if available. When present, this IE shall contain the binding indication of the UE Context for SMS in SMSF and shall be set to the value of the 3gpp-Sbi-Binding header defined in clause 5.2.3.2.6 of 3GPP TS 29.500 [4], without the header name. |
|
disasterRoamingInd |
boolean |
C |
0..1 |
This IE shall be present if the UE is registered for disaster roaming. It may be present otherwise. When present, this IE shall be set as follows: – true: UE is registered for Disaster Roaming service; – false (default): UE is not registered for Disaster Roaming service. |
|
disasterPlmn |
PlmnId |
C |
0..1 |
This IE shall be included if the disasterRoamingInd is present and set to "true". When present, this IE includes the PLMN of the UE which has faced disaster condition |
|
NOTE 1: If the restrictedPrimaryRatList and restrictedSecondaryRatList attributes are supported by the sender, the sender shall include the list of RAT Types that are restricted, if any, in the restrictedRatList attribute, shall include the list of RAT Types that are restricted for use as primary RAT, if any, in the restrictedPrimaryRatList attribute and shall include the list of RAT Types that are restricted for use as secondary RAT, if any, in the restrictedSsecondaryRatList attribute. If the restrictedPrimaryRatList and restrictedSecondaryRatList attributes are supported by the receiver, the receiver shall use the data in the restrictedPrimaryRatList attribute, if received, as the list of RAT Types that are restricted for use as primary RAT for the UE, and shall use the data in the restrictedSecondaryRatList attribute, if received, as the list of RAT Types that are restricted for use as secondary RAT for the UE, otherwise the receiver shall use the data in the restrictedRatList attribute, if received, as the list of RAT Types that are restricted for the UE. NOTE 2: A particular PDU session not supported by the target AMF shall not be transferred, e.g. MA-PDU session context shall not be transferred if target AMF does not support ATSSS. NOTE 3: After ecRestrictionDataWb and/or ecRestrictionDataNb attributes are sent from source AMF to target AMF to build the UeContext in the target AMF, the target AMF shall re-determine the EC restriction information based on the received subscription data from UDM and UE 5GMM capability because EC restriction information may change (e.g. due to that subscription data in UDM is changed but not notified the old AMF yet) and then compare the re-determined EC restriction information with the one received in the UeContext. If the target AMF finds EC restriction information has changed after comparing, the target AMF shall proceed as described in clause 5.31.12, 3GPP TS 23.501 [2]. NOTE 4: If present, this attribute shall be used together with routingIndicator. This attribute is only used by the HPLMN in roaming scenarios. NOTE 5: If the information as indicated in both IEs were received from the PCF for the UE or from the old AMF in UE Context, the AMF shall identify whether a non-roaming or local breakout PDU session is applicable for SM Policy Association events, i.e, whethe the slice and DNN combination of the PDU session is listed in the smPolicyNotifyPduList IE or not. If the PDU session is applicable for notification of SM Policy Association events , the AMF shall provide the callback information for the PCF of the UE contained in the pcfUeCallbackInfo IE to the SMF of a new PDU session via Create SM Context service operation, or to the SMF for an ongoing PDU session via Update SM Context service operation, together with the indication for notification of SM Policy Association events. See clause 4.3.2.2.1 and clause 4.3.3.2 of 3GPP TS 23.502 [3]. NOTE 6: This IE is deprecated. An AMF complying with this version of specification shall use the pcfAmpBindingInfo IE to carry the Binding indication of the AM Policy Association resource and use the pcfUepBindingInfo IE to carry the binding indication of the UE Policy Association resource. |
6.1.6.2.26 Type: N2SmInformation
Table 6.1.6.2.26-1: Definition of type N2SmInformation
Attribute name |
Data type |
P |
Cardinality |
Description |
Applicability |
pduSessionId |
PduSessionId |
M |
1 |
Indicates the PDU Session Identity |
|
n2InfoContent |
N2InfoContent |
C |
0..1 |
This IE shall be present if a SMF related IE should be transferred. When present, the IE contains one of NGAP SMF related IEs specified in clause 9.3.4 of 3GPP TS 38.413 [12]. |
|
sNssai |
Snssai |
C |
0..1 |
This IE shall be present if network slice information to be transferred for session management. When present, the IE indicates the network slice the PDU session belongs to. (NOTE) |
|
homePlmnSnssai |
Snssai |
C |
0..1 |
This IE shall be present during EPS to 5GS handover procedure for Home Routed PDU session. When present, it shall carry the S-NSSAI for home PLMN. |
ENS |
iwkSnssai |
Snssai |
C |
0..1 |
This IE shall be present during EPS to 5GS handover procedure with AMF relocation for Home Routed PDU session, if S-NSSAI for interworking is configured and used in the initial AMF, as specified in clause 4.11.1.2.2 of 3GPP TS 23.502 [3]. When present, this IE shall carry the S-NSSAI for interworking configured and used in the initial AMF for the PDU session. |
ENS |
subjectToHo |
boolean |
C |
0..1 |
This IE shall be present if n2InfoContent carries a " Handover Required Transfer" IE. When present, it Indicates whether the PDU session shall be subject to handover to the target node. |
|
NOTE: During EPS to 5GS handover procedure for Home Routed PDU session with AMF relocation, the source AMF shall set this IE to the S-NSSAI in the serving PLMN mapped from the S-NSSAI in home PLMN indicated by the homePlmnSnssai IE in the N2SmInformation data structure sent to target AMF. |
6.1.6.2.27 Type: N2InfoContent
Table 6.1.6.2.27-1: Definition of type N2InfoContent
Attribute name |
Data type |
P |
Cardinality |
Description |
ngapMessageType |
Uinteger |
C |
0..1 |
This IE shall be present if PWS related N2 information is to be transferred, or during the AMF planned removal procedure with UDSF deployed procedure to transfer a RAN N2 message. When present, it shall indicate the NGAP Message type of the ngapData as specified in clause 6.1.6.4.3.3. Its value equals the value of the Procedure Code defined in ASN.1 in clause 9.4.7 in 3GPP TS 38.413 [12]. |
ngapIeType |
NgapIeType |
C |
0..1 |
This IE shall be present if SM, RAN, V2X or NRPPa related N2 information is to be transferred. When present, it shall indicate the NGAP IE type of the ngapData as specified in clause 6.1.6.4.3.2. |
ngapData |
RefToBinaryData |
M |
1 |
This IE reference the N2 Information binary data corresponding to the N2 information class. See clause 6.1.6.4.3. |
6.1.6.2.28 Type: NrppaInformation
Table 6.1.6.2.28-1: Definition of type NrppaInformation
Attribute name |
Data type |
P |
Cardinality |
Description |
nfId |
NfInstanceId |
M |
1 |
This IE shall carry the identifier of the Network Function (e.g. LMF) instance that is sending or receiving the NRPPa data. |
nrppaPdu |
N2InfoContent |
M |
1 |
This IE represents the encoded NGAP NRPPa-PDU IE, which is transparent to AMF. |
serviceInstanceId |
string |
O |
0..1 |
When present, this IE shall carry the Service Instance Identifier of the Service Instance (e.g. LMF) that is sending or receiving the NRPPa data. |
6.1.6.2.29 Type: PwsInformation
Table 6.1.6.2.29-1: Definition of type PwsInformation
Attribute name |
Data type |
P |
Cardinality |
Description |
messageIdentifier |
Uint16 |
M |
1 |
Identifies the warning message. Sender shall set this field to 0, if the pwsContainer IE carries PWS Failure Indication or PWS Restart Indication. The receiver shall ignore this IE if the pwsContainer IE carries PWS Failure Indication or PWS Restart Indication. |
serialNumber |
Uint16 |
M |
1 |
identifies a particular message from the source and type indicated by the Message Identifier. Sender shall set this field to 0, if the pwsContainer IE carries PWS Failure Indication or PWS Restart Indication. The receiver shall ignore this IE if the pwsContainer IE carries PWS Failure Indication or PWS Restart Indication. |
pwsContainer |
N2InfoContent |
M |
1 |
This IE represents the PWS N2 information data part to be relayed between CBCF and AN. |
bcEmptyAreaList |
array(GlobalRanNodeId) |
C |
1..N |
This IE shall be present if the NF consumer has previously requested the AMF to send the N2 response information for: – WRITE-REPLACE-WARNING-REQUEST and the AMF has received WRITE-REPLACE-WARNING-RESPONSE from RAN node(s) not including the Broadcast Completed Area List IE, or – PWS-CANCEL-REQUEST and the AMF has received PWS-CANCEL-RESPONSE from RAN node(s) not including the Broadcast Cancelled Area List IE. When present, this IE shall list the RAN node(s) that has sent a – WRITE-REPLACE-WARNING-RESPONSE not including the Broadcast Completed Area List IE, or – PWS-CANCEL-RESPONSE not including the Broadcast Cancelled Area List IE. |
sendRanResponse |
boolean |
O |
0..1 |
This IE shall be present to request the AMF to send the N2 response information it has received from the RAN nodes to the NF Service Consumer. When present, this IE shall be set as follows: – true: send RAN response – false (default): do not send RAN response. The N2 information received from the RAN corresponds to the Broadcast-Completed-Area-List IE or the Broadcast-Cancelled-Area-List IE defined in 3GPP TS 38.413 [12]. See clause 6.1.6.4.3.3. |
omcId |
OmcIdentifier |
O |
0..1 |
IE shall be present if the AMF is required to write the n2Information it has received from the RAN nodes into trace records on the OMC. When present, it indicates the identifier of OMC. |
nfId |
NfInstanceId |
O |
0..1 |
When present, this IE shall carry the instance identity of the NF Service Consumer (e.g. CBCF or PWS-IWF). |
6.1.6.2.30 Type: N1N2MsgTxfrFailureNotification
Table 6.1.6.2.30-1: Definition of type N1N2MsgTxfrFailureNotification
Attribute name |
Data type |
P |
Cardinality |
Description |
cause |
N1N2MessageTransferCause |
M |
1 |
This IE shall provide the result of the N1/N2 message transfer at the AMF. |
n1n2MsgDataUri |
Uri |
M |
1 |
This IE shall contain the N1N2MessageTransfer request resource URI returned in the Location header when the N1/N2 message transfer was initiated (see clause 6.1.3.5.3.1). This IE shall be used by the NF Service Consumer to correlate the notification with the UE or session for which the earlier N1/N2 message transfer was initiated. If no Location header was returned when the N1/N2 message transfer was initiated, e.g. when a 200 OK response was sent for a UE in RRC inactive state, this IE shall be set to a dummy URI, i.e. an URI with no authority and an empty path (e.g. "http:"). |
retryAfter |
Uinteger |
O |
0..1 |
This IE may be included if the AMF requests the NF Service Consumer to throttle sending further N1/N2 Message Transfer request for a short period, e.g. when UE is not responding to paging. When present, this IE indicates the period in number of seconds. The NF consumer should not send new N1/N2 message transfer request during the indicated period. (NOTE) |
NOTE: This IE should be configured with a value less then 10 minutes, i.e. 600 seconds. |
6.1.6.2.31 Type: N1N2MessageTransferError
Table 6.1.6.2.31-1: Definition of type N1N2MessageTransferError
Attribute name |
Data type |
P |
Cardinality |
Description |
error |
ProblemDetails |
M |
1 |
This IE shall provide the result of the N1/N2 message transfer processing at the AMF. |
errInfo |
N1N2MsgTxfrErrDetail |
O |
0..1 |
This IE may be included to provide additional information related to the error. |
6.1.6.2.32 Type: N1N2MsgTxfrErrDetail
Table 6.1.6.2.32-1: Definition of type N1N2MsgTxfrErrDetail
Attribute name |
Data type |
P |
Cardinality |
Description |
retryAfter |
Uinteger |
O |
0..1 |
This IE may be included if the AMF requests the NF Service Consumer to stop sending the N1/N2 message before timeout, and to retry the N1/N2 message transfer request that was rejected after a timeout. The value shall be in seconds. When included, the value shall be set to an estimate of the AMF on how long it will take before the AMF considers paging procedure as completed. |
highestPrioArp |
Arp |
O |
0..1 |
This IE may be included if the "cause" attribute in the ProblemDetails is set to "HIGHER_PRIORITY_REQUEST_ONGOING". When included this IE shall contain the ARP value of the highest priority QoS flow for which currently paging is ongoing. The NF Service Consumer shall not initiate an Namf_Communication_N1N2MessageTransfer operation for the same UE with an ARP value having a lower priority than this or the same priority as this, until the retryAfter timer expires. |
maxWaitingTime |
DurationSec |
C |
0..1 |
This IE shall be present when: – extBufSupport attribute with value "true" received in the request; and – the UE is not reachable due to the UE in MICO mode or the UE using extended idle mode DRX. When present, this IE shall indicate the estimated maximum waiting time in seconds before the UE will be reachable. If the UE is in MICO mode, the AMF determines the Estimated Maximum Wait time based on the next expected periodic registration by the UE or by implementation. If the UE is using extended idle mode DRX, the AMF determines the Estimated Maximum Wait time based on the start of the next Paging Time Window. (see clause 4.25.5 of 3GPP 23.502 [3]) |
6.1.6.2.33 Type: N2InformationTransferRspData
Table 6.1.6.2.33-1: Definition of type N2InformationTransferRspData
Attribute name |
Data type |
P |
Cardinality |
Description |
result |
N2InformationTransferResult |
M |
1 |
This IE shall provide the result of the N2 information transfer processing at the AMF. |
supportedFeatures |
SupportedFeatures |
C |
0..1 |
This IE shall be present if at least one optional feature defined in clause 6.1.8 is supported. |
pwsRspData |
PWSResponseData |
C |
0..1 |
This IE shall be present if the n2InformationClass is "PWS" in N2InformationTransferReqData. |
6.1.6.2.34 Type: MmContext
Table 6.1.6.2.34-1: Definition of type MmContext
Attribute name |
Data type |
P |
Cardinality |
Description |
accessType |
AccessType |
M |
1 |
This IE shall contain the access type of the MM context. |
nasSecurityMode |
NasSecurityMode |
C |
0..1 |
This IE shall be present if available in 3GPP access MM context. When present, this IE shall contain the used NAS security mode of the UE. |
epsNasSecurityMode |
EpsNasSecurityMode |
C |
0..1 |
This IE shall be present in 3GPP access MM context if selected EPS NAS security algorithms have been previously provided to the UE, as specified in clause 6.7.2 of 3GPP TS 33.501 [27]. When present, this IE shall contain the selected EPS NAS security algorithms provided to the UE. |
nasDownlinkCount |
NasCount |
C |
0..1 |
This IE shall be present if available in 3GPP access MM context. When present, this IE shall contain the NAS downlink count of the UE. |
nasUplinkCount |
NasCount |
C |
0..1 |
This IE shall be present if available in 3GPP access MM context. When present, this IE shall contain the NAS uplink count of the UE. |
ueSecurityCapability |
UeSecurityCapability |
C |
0..1 |
This IE shall be present if available in 3GPP access MM context. When present, this IE shall contain the UE security capability |
s1UeNetworkCapability |
S1UeNetworkCapability |
C |
0..1 |
This IE shall be present if available in 3GPP access MM context. When present, this IE shall contain the S1 UE network capabilities. |
allowedNssai |
array(Snssai) |
C |
1..N |
This IE shall be present if the source AMF and the target AMF are in the same PLMN and if available. When present, this IE shall contain the allowed NSSAI for the access type. |
nssaiMappingList |
array(NssaiMapping) |
C |
1..N |
This IE shall be present if the source AMF and the target AMF are in the same PLMN and if available. When present, this IE shall contain the mapping of the allowed NSSAI for the UE. |
allowedHomeNssai |
array(Snssai) |
C |
1..N |
This IE shall be present if the source AMF and the target AMF are in different PLMNs and if available. When present, this IE shall contain the home S-NSSAIs corresponding to the allowed NSSAI for the access type. |
nsInstanceList |
array(NsiId) |
C |
1..N |
This IE shall be present if available. When present, it shall indicate the Network Slice Instances selected for the UE. |
expectedUEbehavior |
ExpectedUeBehavior |
C |
0..1 |
This IE shall be present if available. When present it shall indicate the expected UE moving trajectory and its validity period. See 3GPP TS 23.502 [3] clause 4.15.6.3. |
ueDifferentiationInfo |
UeDifferentiationInfo |
C |
0..1 |
This IE shall be present if available. When present it shall indicate UE Differentiation Information and its validity period. |
plmnAssiUeRadioCapId |
PlmnAssiUeRadioCapId |
C |
0..1 |
This IE shall be present if the source AMF supports RACS feature and if available. When present it shall be the PLMN-assigned UE Radio Capability ID. (NOTE 1) |
manAssiUeRadioCapId |
ManAssiUeRadioCapId |
C |
0..1 |
This IE shall be present if the source AMF supports RACS feature and if available. When present it shall be the Manufacturer-assigned UE Radio Capability ID. |
ucmfDicEntryId |
string |
C |
0..1 |
This IE shall be present if the source AMF supports RACS feature and if available. When present it shall be the UCMF allocated dicEntryId received from the UCMF. |
n3IwfId |
GlobalRanNodeId |
C |
0..1 |
This IE shall be present during Registration procedure with AMF changes as specified in clause 4.2.2.2 of 3GPP TS 23.502 [3] and inter AMF handover procedure, if the old AMF holds UE context established via N3IWF and if the PDU sessions associated with the non-3GPP access are transferred to the new AMF (see clause 5.2.2.2.1.1 and 5.2.2.2.3.1). When present, this IE shall contain the Global RAN Node ID of N3IWF. |
wagfId |
GlobalRanNodeId |
C |
0..1 |
This IE shall be present during Registration procedure with AMF changes as specified in clause 4.2.2.2 of 3GPP TS 23.502 [3] and inter AMF handover procedure, if the old AMF holds UE context established via W-AGF and if the PDU sessions associated with the non-3GPP access are transferred to the new AMF (see clause 5.2.2.2.1.1 and 5.2.2.2.3.1). When present, this IE shall contain the Global RAN Node ID of W-AGF. |
tngfId |
GlobalRanNodeId |
C |
0..1 |
This IE shall be present during Registration procedure with AMF changes as specified in clause 4.2.2.2 of 3GPP TS 23.502 [3] and inter AMF handover procedure, if the old AMF holds UE context established via TNGF and if the PDU sessions associated with the non-3GPP access are transferred to the new AMF (see clause 5.2.2.2.1.1 and 5.2.2.2.3.1). When present, this IE shall contain the Global RAN Node ID of TNGF. |
anN2ApId |
integer |
C |
0..1 |
This IE shall be present during Registration procedure with AMF changes, as specified in clause 4.2.2.2 of 3GPP TS 23.502 [3] and inter AMF handover procedure, if the old AMF holds UE context established via N3IWF/W-AGF/TNGF and the UE is in CM-CONNECTED state via N3IWF/W-AGF/TNGF and if the PDU sessions associated with the non-3GPP access are transferred to the new AMF (see clause 5.2.2.2.1.1 and 5.2.2.2.3.1). When present, this IE shall contain the RAN UE NGAP ID over N2 interface. |
nssaaStatusList |
array(NssaaStatus) |
C |
1..N |
This IE shall be present if available. When present, it shall contain the subscribed S-NSSAIs subject to NSSAA procedure and for which a status information is available. See 3GPP TS 23.501 [2] clause 5.15.5.2.1 and 3GPP TS 23.502 [3] clause 5.2.2.2.2. |
pendingNssaiMappingList |
array(NssaiMapping) |
C |
1..N |
This IE shall be present if available. When present, this IE shall contain the mapping of the pending NSSAI for the UE. |
uuaaMmStatus |
UuaaMmStatus |
C |
0..1 |
This IE shall be present if available in 3GPP access MM context. When present, this IE shall indicate the status of UUAA-MM if the AMF is configured to perform the UAV authentication/authorization at 5GS registration as described in clause 5.2.2 of 3GPP TS 23.256 [56]. |
NOTE 1: If the AMF supports RACS and the AMF detects that the selected PLMN during a service request procedure is different from the currently registered PLMN for the UE, the AMF stores the UE Radio Capability ID of the newly selected PLMN in the UE context as described in clause 5.2.3.2 of 3GPP TS 23.502 [3], and provides this UE Radio Capability ID to the target AMF during any subsequent inter-AMF mobility. |
6.1.6.2.35 Type: SeafData
Table 6.1.6.2.35-1: Definition of type SeafData
Attribute name |
Data type |
P |
Cardinality |
Description |
ngKsi |
NgKsi |
M |
1 |
Indicates the KSI used for the derivation of the keyAmf sent. |
keyAmf |
KeyAmf |
M |
1 |
Indicates the Kamf or K’amf |
nh |
string |
C |
0..1 |
This IE shall be present during N2 handover procedure as specified in clause 6.9.2.3.3 of 3GPP TS 33.501 [27]. When present, this IE indicates the Next Hop value used for the key derivation. The value is encoded as a string of hexadecimal characters. Pattern: ‘^[A-Fa-f0-9]+$’ |
ncc |
integer |
C |
0..1 |
This IE shall be present during N2 handover procedure as specified in clause 6.9.2.3.3 of 3GPP TS 33.501 [27]. When present, this IE indicates the NH Chaining Counter. The value is within the range 0 to 7. |
keyAmfChangeInd |
boolean |
C |
0..1 |
This IE shall be included, with a value "true", if the source AMF requires the target AMF to perform AS key re-keying, during N2 handover procedure as specified in clause 6.9.2.3.3 of 3GPP TS 33.501 [27]. |
keyAmfHDerivationInd |
boolean |
C |
0..1 |
This IE shall be included, with a value "true", if the source AMF has performed horizontal KAMF derivation, which means a new KAMF has been calculated. |
6.1.6.2.36 Type: NasSecurityMode
Table 6.1.6.2.36-1: Definition of type NasSecurityMode
Attribute name |
Data type |
P |
Cardinality |
Description |
integrityAlgorithm |
IntegrityAlgorithm |
M |
1 |
Indicates the integrity protection algorithm |
cipheringAlgorithm |
CipheringAlgorithm |
M |
1 |
Indicates the ciphering algorithm |
6.1.6.2.37 Type: PduSessionContext
Table 6.1.6.2.37-1: Definition of type PduSessionContext
Attribute name |
Data type |
P |
Cardinality |
Description |
Applicability |
pduSessionId |
PduSessionId |
M |
1 |
Indicates the identifier of the PDU Session. |
|
smContextRef |
Uri |
M |
1 |
Indicates the resource URI of the SM context, including the apiRoot (see clause 6.1.3.3.2 of 3GPP TS 29.502 [16]). When present, it shall carry the URI of SM Context of: – I-SMF, for a PDU session with I-SMF; or – V-SMF, for HR PDU session; or – SMF, for non-roaming PDU session without I-SMF, or LBO roaming PDU session; |
|
sNssai |
Snssai |
M |
1 |
Indicates the associated S-NSSAI for the PDU Session. It shall be the S-NSSAI in HPLMN in non-roaming, LBO roaming or HR roaming. |
|
additionalSnssai |
Snssai |
C |
0..1 |
This IE shall be present in intra-VPLMN mobility of LBO roaming and HR roaming. When present, this IE shall indicate the associated S-NSSAI in VPLMN for the PDU Session. |
|
dnn |
Dnn |
M |
1 |
This IE shall indicate the Data Network Name. The DNN shall be the full DNN (i.e. with both the Network Identifier and Operator Identifier) for a HR PDU session, and it should be the full DNN in LBO and non-roaming scenarios. If the Operator Identifier is absent, the serving core network operator shall be assumed. |
|
selectedDnn |
Dnn |
C |
0..1 |
This IE shall be present, if another DNN other than the UE requested DNN is selected for this PDU session. When present, it shall contain the selected DNN. The DNN shall be the full DNN (i.e. with both the Network Identifier and Operator Identifier) for a HR PDU session, and it should be the full DNN in LBO and non-roaming scenarios. If the Operator Identifier is absent, the serving core network operator shall be assumed. |
|
accessType |
AccessType |
M |
1 |
Indicates the access type of the PDU session. |
|
additionalAccessType |
AccessType |
C |
0..1 |
Indicates the additional access type for a MA PDU session, if the UE registers to both 3GPP access and Non-3GPP access. |
|
allocatedEbiList |
array(EbiArpMapping) |
C |
1..N |
This IE shall be present when at least one EBI is allocated to the PDU session. When present, this IE shall contain the EBIs currently allocated to the PDU session. |
|
hsmfId |
NfInstanceId |
C |
0..1 |
This IE shall be present for non-roaming and home-routed PDU sessions. When present, it shall indicate the associated: – home SMF for HR PDU Session, or – SMF, for non-roaming PDU session, regardless of whether an I-SMF is involved or not. |
|
hsmfSetId |
NfSetId |
C |
0..1 |
This IE shall be present, if available. When present, this IE shall contain the NF Set ID of the home SMF or the SMF indicated by hsmfId. |
|
hsmfServiceSetId |
NfServiceSetId |
C |
0..1 |
This IE shall be present, if available. When present, this IE shall contain the NF Service Set ID of the selected PDUSession service instance of home SMF or the SMF indicated by hsmfId. |
|
smfBinding |
SbiBindingLevel |
C |
0..1 |
This IE shall be present if available, for a non-roaming PDU session. When present, this IE shall contain the SBI binding level of the SMF’s SM context resource. |
|
vsmfId |
NfInstanceId |
C |
0..1 |
This IE shall be present for roaming PDU sessions. When present, it shall indicate the associated visited SMF for home-routed the PDU Session, or the SMF for the local-breakout PDU session (regardless of whether an I-SMF is involved or not). |
|
vsmfSetId |
NfSetId |
C |
0..1 |
This IE shall be present, if available. When present, this IE shall contain the NF Set ID of the V-SMF. |
|
vsmfServiceSetId |
NfServiceSetId |
C |
0..1 |
This IE shall be present, if available. When present, this IE shall contain the NF Service Set ID of the V-SMF’s PDUSession service instance. |
|
vsmfBinding |
SbiBindingLevel |
C |
0..1 |
This IE shall be present, if available. When present, this IE shall contain the SBI binding level of the V-SMF’s SM context resource. |
|
ismfId |
NfInstanceId |
C |
0..1 |
This IE shall be present if I-SMF is involved in the PDU session. When present, it shall indicate the associated I-SMF for the PDU Session. |
DTSSA |
ismfSetId |
NfSetId |
C |
0..1 |
This IE shall be present, if available. When present, this IE shall contain the NF Set ID of the I-SMF. |
DTSSA |
ismfServiceSetId |
NfServiceSetId |
C |
0..1 |
This IE shall be present, if available. When present, this IE shall contain the NF Service Set ID of the I-SMF’s PDUSession service instance. |
DTSSA |
ismfBinding |
SbiBindingLevel |
C |
0..1 |
This IE shall be present if available. When present, this IE shall contain the SBI binding level of the I-SMF’s SM Context resource. |
DTSSA |
nsInstance |
NsiId |
C |
0..1 |
This IE shall be present if available. When present, this IE shall Indicate Network Slice Instance for the PDU Session |
|
smfServiceInstanceId |
string |
O |
0..1 |
When present, this IE shall contain the serviceInstanceId of the SMF PDUSession service instance serving the SM Context, i.e. of: – the I-SMF, for a PDU session with I-SMF; – the V-SMF, for a HR PDU session; or – the SMF, for a non-roaming or an LBO roaming PDU session without I-SMF. This IE may be used by the AMF to identify PDU session contexts affected by a failure or restart of the SMF service instance (see clause 6.2 of 3GPP TS 23.527 [33]). |
|
maPduSession |
boolean |
C |
0..1 |
This IE shall be present if available. When present, this IE shall indicate whether it is an MA PDU session. true: indicates the PDU session is MA PDU session; false (default): the PDU session is not MA PDU session. |
|
cnAssistedRanPara |
CnAssistedRanPara |
C |
0..1 |
This IE shall be present if available. When present, this IE shall contain the PDU Session specific parameters received from the SMF and used by the AMF to derive the Core Network assisted RAN parameters tuning. |
|
nrfManagementUri |
Uri |
C |
0..1 |
If included, this IE shall contain the API URI of the NFManagement Service (see clause 6.1.1 of 3GPP TS 29.510 [29]) of the NRF or hNRF. It shall be present if it is returned from the NSSF or hNSSF (see clause 6.1.6.2.7 of 3GPP TS 29.531 [18]). |
|
nrfDiscoveryUri |
Uri |
C |
0..1 |
If included, this IE shall contain the API URI of the NFDiscovery Service (see clause 6.2.1 of 3GPP TS 29.510 [29]) of the NRF or hNRF. It shall be present if it is returned from the NSSF or hNSSF (see clause 6.1.6.2.7 of 3GPP TS 29.531 [18]). |
|
nrfAccessTokenUri |
Uri |
C |
0..1 |
If included, this IE shall contain the API URI of the Access Token Service (see clause 6.3.2 of 3GPP TS 29.510 [29]) of the NRF or hNRF. It shall be present if it is returned from the NSSF or hNSSF (see clause 6.1.6.2.7 of 3GPP TS 29.531 [18]). |
|
smfBindingInfo |
string |
C |
0..1 |
This IE shall be present if available, for a non-roaming PDU session. When present, this IE shall contain the Binding indications of the SMF’s SM context resource and shall be set to the value of the 3gpp-Sbi-Binding header defined in clause 5.2.3.2.6 of 3GPP TS 29.500 [4], without the header name. |
|
vsmfBindingInfo |
string |
C |
0..1 |
This IE shall be present, if available. When present, this IE shall contain the Binding indications of the V-SMF’s SM context resource and shall be set to the value of the 3gpp-Sbi-Binding header defined in clause 5.2.3.2.6 of 3GPP TS 29.500 [4], without the header name. |
|
ismfBindingInfo |
string |
C |
0..1 |
This IE shall be present if available. When present, this IE shall contain the Binding indications of the I-SMF’s SM Context resource and shall be set to the value of the 3gpp-Sbi-Binding header defined in clause 5.2.3.2.6 of 3GPP TS 29.500 [4], without the header name. |
DTSSA |
interPlmnApiRoot |
Uri |
C |
0..1 |
This IE shall be present if this information is available. When present, it shall contain the apiRoot of the SM context to be used in inter-PLMN signalling request targeting the SM context. (NOTE) |
|
pgwFqdn |
Fqdn |
O |
0..1 |
FQDN of the PGW in the PGW-C+SMF, to be included for interworking with EPS. |
|
pgwIpAddr |
IpAddress |
O |
0..1 |
IP Address of the PGW in the PGW-C+SMF, to be included for interworking with EPS. |
|
plmnId |
PlmnId |
O |
0..1 |
PLMN where the PGW-C+SMF is located. |
|
anchorSmfSupportedFeatures |
SupportedFeatures |
O |
0..1 |
When present, this IE shall include the features of the Nsmf_PDUSession service (see clause 6.1.8 of 3GPP TS 29.502 [16]) that are supported by the H-SMF (or the SMF for a PDU sessions with I-SMF). (NOTE 2) |
|
anchorSmfOauth2Required |
boolean |
O |
0..1 |
This IE may be present when new AMF and old AMF belong to the same PLMN. When present, this IE shall indicate whether the H-SMF (or the SMF for a PDU session with I-SMF) requires Oauth2-based authorization for accessing its Nsmf_PDUSession service – true: OAuth2 based authorization is required. – false: OAuth2 based authorization is not required. The absence of this IE means that no indication is available about the usage of Oauth2 for authorization of the anchor SMF’s Nsmf_PDUSession service. |
|
NOTE 1: During an inter-PLMN mobility, the target AMF shall replace the apiRoot of the smContextRef with the interPlmnApiRoot if available and send the resulting smContextRef in the Create SM Context request towards the target V-SMF, I-SMF or anchor SMF. See 3GPP TS 29.502 [16]. NOTE 2: The new AMF may use this IE to know the supported features of the H-SMF (or the SMF for a PDU session with I-SMF) and take action based on the supported features, e.g. the new AMF shall release the PDU session when V-SMF needs to be changed but the H-SMF does not support V-SMF change. |
6.1.6.2.38 Type: NssaiMapping
Table 6.1.6.2.38-1: Definition of type NssaiMapping
Attribute name |
Data type |
P |
Cardinality |
Description |
mappedSnssai |
Snssai |
M |
1 |
Indicates the mapped S-NSSAI in the serving PLMN |
hSnssai |
Snssai |
M |
1 |
Indicates the S-NSSAI in home PLMN |
6.1.6.2.39 Type: UeRegStatusUpdateReqData
Table 6.1.6.2.39-1: Definition of type UeRegStatusUpdateReqData
Attribute name |
Data type |
P |
Cardinality |
Description |
Applicability |
transferStatus |
UeContextTransferStatus |
M |
1 |
This IE shall indicate if the previous UE context transfer was completed. |
|
toReleaseSessionList |
array(PduSessionId) |
C |
1..N |
This IE shall be present during UE Context Transfer procedure, if there are any PDU session(s) associated with Network Slice(s) which become no longer available. When present, this IE shall include all the PDU session(s) associated with no longer available S-NSSAI(s). |
|
pcfReselectedInd |
boolean |
C |
0..1 |
This IE shall be present and set to true if the target AMF has decided to select a new PCF for AM Policy and/or UE Policy other than the one which was included in the UeContext by the old AMF. When present, it shall be set as follows: – true: the target AMF has selected new PCF(s) other than the one which was included in the UeContext by the old AMF for AM Policy and/or UE Policy. |
|
smfChangeInfoList |
array(SmfChangeInfo) |
C |
1..N |
This IE shall be present during an inter-AMF registration procedure, if there is an I-SMF or V-SMF change or removal for the related PDU session(s). When present, this IE shall indicate the I-SMF/V-SMF situation after the registration completion at the target AMF. |
DTSSA |
analyticsNotUsedList |
array(Uri) |
C |
1..N |
This IE shall be present to include the list of resource URIs of the analytics subscription(s) that are not taken over in the target AMF. |
|
toReleaseSessionInfo |
array(ReleaseSessionInfo) |
C |
1..N |
This IE shall be present during UE Context Transfer procedure, if there are any PDU session(s) that cannot be supported in the target AMF for a reason other than no longer available S-NSSAI(s) as specified in step 1 of clause 5.2.2.2.2.1. When present, this IE shall include list of the PDU session(s) and the release cause. |
6.1.6.2.40 Type: AssignEbiError
Table 6.1.6.2.40-1: Definition of type AssignEbiError
Attribute name |
Data type |
P |
Cardinality |
Description |
error |
ProblemDetails |
M |
1 |
Represents the application error information. The application level error cause shall be encoded in the "cause" attribute. |
failureDetails |
AssignEbiFailed |
M |
1 |
Describes the details of the failure including the list of ARPs for which the EBI assignment failed. |
6.1.6.2.41 Type: UeContextCreateData
Table 6.1.6.2.41-1: Definition of type UeContextCreateData
Attribute name |
Data type |
P |
Cardinality |
Description |
Applicability |
ueContext |
UeContext |
M |
1 |
Represents an individual ueContext resource to be created |
|
targetId |
NgRanTargetId |
M |
1 |
Represents the identification of target RAN |
|
sourceToTargetData |
N2InfoContent |
M |
1 |
This IE shall be included to contain the "Source to Target Transparent Container". |
|
pduSessionList |
array(N2SmInformation) |
M |
1..N |
This IE shall be included to contain the list of N2SmInformation, where each N2SmInformation includes the "Handover Required Transfer" received from the source RAN per PDU session ID. |
|
n2NotifyUri |
Uri |
M |
1 |
This IE shall contain a callback URI to receive the N2 Information Notification. |
|
ueRadioCapability |
N2InfoContent |
C |
0..1 |
This IE shall be included to contain the "UE Radio Capability Information" if available. |
|
ueRadioCapabilityForPaging |
N2InfoContent |
C |
0..1 |
This IE shall be included to contain the "UE Radio Capability for Paging" if available. |
|
ngapCause |
NgApCause |
C |
0..1 |
This IE shall be present, if available. When present, it shall represent the NGAP Cause received from RAN. |
|
supportedFeatures |
SupportedFeatures |
C |
0..1 |
This IE shall be present if at least one optional feature defined in clause 6.1.8 is supported. |
|
servingNetwork |
PlmnIdNid |
C |
0..1 |
A Source AMF complying with this release of the specification shall include this IE to indicate the current Serving Network. When present, this IE shall contain the serving core network operator PLMN ID and, for an SNPN, the NID that together with the PLMN ID identifies the SNPN. |
6.1.6.2.42 Type: UeContextCreatedData
Table 6.1.6.2.42-1: Definition of type UeContextCreatedData
Attribute name |
Data type |
P |
Cardinality |
Description |
ueContext |
UeContext |
M |
1 |
Represents the newly created individual ueContext resource |
targetToSourceData |
N2InfoContent |
M |
1 |
This IE shall contain the "Target to Source Transparent Container". |
pduSessionList |
array(N2SmInformation) |
M |
1..N |
This IE shall be included to contain the list of N2SmInformation, where each N2SmInformation includes the "Handover Command Transfer" received from the SMF, per PDU session ID. |
pcfReselectedInd |
boolean |
C |
0..1 |
This IE shall be present and set to true if the target AMF has decided to select a new PCF for AM Policy and/or UE Policy other than the one which was included in the UeContext by the old AMF. When present, it shall be set as follows: – true: the target AMF has selected a new PCF other than the one which was included in the UeContext by the old AMF for AM Policy and/or UE Policy. |
failedSessionList |
array(N2SmInformation) |
C |
1..N |
This IE shall be included to contain a list of N2SmInformation, where each N2SmInformation includes the "Handover Preparation Unsuccessful Transfer" N2 SM content either received from the SMF for a PDU session failed to be handed over or generated by the target AMF for a PDU session not accepted by the target AMF (e.g. due to no response from the SMF within a maximum wait timer or due to non-available S-NSSAI in the target AMF). See NOTE. |
supportedFeatures |
SupportedFeatures |
C |
0..1 |
This IE shall be present if at least one optional feature defined in clause 6.1.8 is supported. |
analyticsNotUsedList |
array(Uri) |
C |
1..N |
This IE shall be present to include the list of resource URIs of the analytics subscription(s) that are not taken over in the target AMF. |
NOTE: As an exception, the AMF generates N2 SM Information (Handover Preparation Unsuccessful Transfer IE) for a PDU session not accepted by the AMF, since this N2 SM IE needs to be included in the Handover Command sent by the source AMF to the source NG-RAN; this N2 SM IE carries a Cause value. |
6.1.6.2.43 Type: UeContextCreateError
Table 6.1.6.2.43-1: Definition of type UeContextCreateError
Attribute name |
Data type |
P |
Cardinality |
Description |
Applicability |
error |
ProblemDetails |
M |
1 |
Represents the detailed application error information. The application level error cause shall be encoded in the "cause" attribute. |
|
ngapCause |
NgApCause |
C |
0..1 |
This IE shall be present, if available. When present, it shall represent the NGAP Cause received from RAN. |
|
targetToSourceFailureData |
N2InfoContent |
C |
0..1 |
This IE shall be present if a "Target to Source Failure Transparent Container" has been received from the target NG-RAN. When present, this IE shall contain this container. |
NPN |
6.1.6.2.44 Type: NgRanTargetId
Table 6.1.6.2.44-1: Definition of type NgRanTargetId
Attribute name |
Data type |
P |
Cardinality |
Description |
ranNodeId |
GlobalRanNodeId |
M |
1 |
Indicates the identity of the RAN node. The IE shall contain either the gNB ID or the NG-eNB ID. |
tai |
Tai |
M |
1 |
Indicates the selected TAI. |
6.1.6.2.45 Type: N2InformationTransferError
Table 6.1.6.2.45-1: Definition of type N2InformationTransferError
Attribute name |
Data type |
P |
Cardinality |
Description |
error |
ProblemDetails |
M |
1 |
More information on the error shall be provided in the "cause" attribute of the "ProblemDetails" structure. |
pwsErrorInfo |
PWSErrorData |
C |
0..1 |
This IE shall be present if the n2InformationClass is "PWS" in N2InformationTransferReqData. |
6.1.6.2.46 Type: PWSResponseData
Table 6.1.6.2.46-1: Definition of type PWSResponseData
Attribute name |
Data type |
P |
Cardinality |
Description |
ngapMessageType |
Uinteger |
M |
1 |
This IE shall identify the message type of the message being sent. Its value is the numeric code of the Procedure Code defined in ASN.1 in clause 9.4.7 in 3GPP TS 38.413 [12]. |
serialNumber |
Uint16 |
M |
1 |
This IE shall contain the Serial Number of the associated PWS response message. |
messageIdentifier |
integer |
M |
1 |
This IE shall contain the Message Identifier of the associated PWS response message. |
unknownTAIList |
array(Tai) |
O |
1..N |
This IE shall contain the Unknown Tracking Area List which may be present in the associated PWS response message. |
6.1.6.2.47 Type: PWSErrorData
Table 6.1.6.2.47-1: Definition of type PWSErrorData
Attribute name |
Data type |
P |
Cardinality |
Description |
namfCause |
integer |
M |
1 |
Represents the cause value for the error that the AMF detected. Cause values: 0 – Message accepted 1 – Parameter not recognised 2 – Parameter value invalid 3 – Valid message not identified 4 – Tracking area not valid 5 – Unrecognised message 6 – Missing mandatory element 7 – AMF capacity exceeded 8 – AMF memory exceeded 9 – Warning broadcast not supported 10 – Warning broadcast not operational 11 – Message reference already used 12 – Unspecified error 13 – Transfer syntax error 14 – Semantic error 15 – Message not compatible with receiver state |
6.1.6.2.48 Void
6.1.6.2.49 Type: NgKsi
Table 6.1.6.2.49-1: Definition of type NgKsi
Attribute name |
Data type |
P |
Cardinality |
Description |
tsc |
ScType |
M |
1 |
Indicates whether the security context type is native or mapped. |
ksi |
integer |
M |
1 |
Indicates the key set identifier value. The value is within the range 0 to 6. |
6.1.6.2.50 Type: KeyAmf
Table 6.1.6.2.50-1: Definition of type KeyAmf
Attribute name |
Data type |
P |
Cardinality |
Description |
keyType |
KeyAmfType |
M |
1 |
Indicates whether the keyAmf represents Kamf or K’amf. |
keyVal |
string |
M |
1 |
Indicates the key value. The key value is encoded as a string of hexadecimal characters. Pattern: ‘^[A-Fa-f0-9]$’ |
6.1.6.2.51 Type: ExpectedUeBehavior
Table 6.1.6.2.25-1: Definition of type ExpectedUeBehavior
Attribute name |
Data type |
P |
Cardinality |
Description |
expMoveTrajectory |
array(UserLocation) |
M |
1..N |
This IE shall contain a list of user location areas where the UE is expected to move. |
validityTime |
DateTime |
M |
1 |
This IE shall contain the time upto which the UE moving trajectory is valid. |
6.1.6.2.52 Type: UeRegStatusUpdateRspData
Table 6.1.6.2.52-1: Definition of type UeRegStatusUpdateRspData
Attribute name |
Data type |
P |
Cardinality |
Description |
regStatusTransferComplete |
boolean |
M |
1 |
This IE shall indicate if the status update of UE context transfer is completed successfully at the source AMF or not. The value shall be set to true if the context transfer is completed successfully and false if the context transfer did not complete successfully. |
6.1.6.2.53 Type: N2RanInformation
Table 6.1.6.2.53-1: Definition of type N2RanInformation
Attribute name |
Data type |
P |
Cardinality |
Description |
n2InfoContent |
N2InfoContent |
M |
1 |
This IE shall contain the N2 RAN information to transfer. |
6.1.6.2.54 Type: N2InfoNotificationRspData
Table 6.1.6.2.54-1: Definition of type N2InfoNotificationRspData
Attribute name |
Data type |
P |
Cardinality |
Description |
secRatDataUsageList |
array(N2SmInformation) |
C |
1..N |
This IE shall be present in the N2InfoNotify response sent by the source AMF to the target AMF during an Inter NG-RAN node N2 based handover procedure (see clause 5.2.2.3.6.2), if Secondary Rat Usage Data are available at the source AMF for one or more PDU sessions. When present, this IE shall contain a list of N2SmInformation, where each N2SmInformation includes the "Secondary RAT Data Usage Report Transfer" information received from the source RAN for a given PDU session. The sNssai IE and subjectToHo IE shall not be included in N2SmInformation. |
6.1.6.2.55 Type: SmallDataRateStatusInfo
Table 6.1.6.2.55-1: Definition of type SmallDataRateStatusInfo
Attribute name |
Data type |
P |
Cardinality |
Description |
singleNssai |
Snssai |
M |
1 |
S-NSSAI |
dnn |
Dnn |
M |
1 |
This IE shall indicate the Data Network Name. The DNN shall be the full DNN (i.e. with both the Network Identifier and Operator Identifier) for a HR PDU session, and it should be the full DNN in LBO and non-roaming scenarios. If the Operator Identifier is absent, the serving core network operator shall be assumed. |
smallDataRateStatus |
SmallDataRateStatus |
M |
1 |
Small data rate status related to the S-NSSAI and Dnn. |
6.1.6.2.56 Type: SmfChangeInfo
Table 6.1.6.2.56-1: Definition of type SmfChangeInfo
Attribute name |
Data type |
P |
Cardinality |
Description |
pduSessionIdList |
array(PduSessionId) |
M |
1..N |
PDU Session ID(s) for which the smfChangeInd applies. |
smfChangeInd |
SmfChangeIndication |
M |
1 |
Indicates the I-SMF or V-SMF change or removal. |
6.1.6.2.57 Type: V2xContext
Table 6.1.6.2.57-1: Definition of type V2xContext
Attribute name |
Data type |
P |
Cardinality |
Description |
nrV2xServicesAuth |
NrV2xAuth |
C |
0..1 |
This IE shall be present if the UE is authorized to use the NR sidelink for V2X services. |
lteV2xServicesAuth |
LteV2xAuth |
C |
0..1 |
This IE shall be present if the UE is authorized to use the LTE sidelink for V2X services. |
nrUeSidelinkAmbr |
BitRate |
C |
0..1 |
This IE shall be present if the UE is authorized for NR V2X services. When present, this IE contains subscription data on UE-PC5-AMBR for NR V2X services. |
lteUeSidelinkAmbr |
BitRate |
C |
0..1 |
This IE shall be present if the UE is authorized for LTE V2X services. When present, this IE contains subscription data on UE-PC5-AMBR for LTE V2X services. |
pc5QoSPara |
Pc5QoSPara |
C |
0..1 |
This IE shall be present if the UE is authorized for NR V2X services. When present, this IE contains policy data on the PC5 QoS parameters. |
6.1.6.2.58 Type: ImmediateMdtConf
Table 6.1.6.2.58-1: Definition of type ImmediateMdtConf
Attribute name |
Data type |
P |
Cardinality |
Description |
jobType |
JobType |
M |
1 |
This IE shall indicate the Job type for MDT, see 3GPP TS 32.422 [30]. |
measurementLteList |
array(MeasurementLteForMdt) |
C |
1..N |
This IE shall be present if available. When present, this IE shall contain a list of the measurements that shall be collected for LTE. |
measurementNrList |
array(MeasurementNrForMdt) |
C |
1..N |
This IE shall be present if available, when present, this IE shall contain a list of the measurements that shall be collected for NR. |
reportingTriggerList |
array(ReportingTrigger) |
C |
1..N |
This IE shall be present if available. When present, this IE shall contain a list of the reporting triggers. |
reportInterval |
ReportIntervalMdt |
C |
0..1 |
This IE shall be present if available. When present, this IE shall indicate the interval between the periodical measurements to be taken when UE is in connected in LTE. |
reportIntervalNr |
ReportIntervalNrMdt |
C |
0..1 |
This IE shall be present if available. When present, this IE shall indicate the interval between the periodical measurements to be taken when UE is in connected in NR. |
reportAmount |
ReportAmountMdt |
C |
0..1 |
This IE shall be present if available. When present, this IE shall indicate the number of measurement reports that shall be taken for periodical reporting while UE is in connected. |
eventThresholdRsrp |
integer |
C |
0..1 |
This IE shall be present if available. When present, this IE shall indicate the Event Threshold for RSRP. Minimum = 0. Maximum = 97. |
eventThresholdRsrq |
integer |
C |
0..1 |
This IE shall be present if available. When present, this IE shall indicate the Event Threshold for RSRQ. Minimum = 0. Maximum = 34. |
eventThresholdRsrpNr |
integer |
C |
0..1 |
This IE shall be present if available. When present, this IE shall indicate the Event Threshold for RSRP in NR. Minimum = 0. Maximum = 127. |
eventThresholdRsrqNr |
integer |
C |
0..1 |
This IE shall be present if available. When present, this IE shall indicate the Event Threshold for RSRQ in NR. Minimum = 0. Maximum = 127. |
collectionPeriodRmmLte |
CollectionPeriodRmmLteMdt |
C |
0..1 |
This IE shall be present if available. When present, it shall contain the collection period that should be used to collect available measurement samples in case of RRM configured measurements. |
collectionPeriodRmmNr |
CollectionPeriodRmmNrMdt |
C |
0..1 |
This IE shall be present if available. When present, it shall contain the collection period that should be used to collect available measurement samples in case of RRM configured measurements when UE is in NR. |
measurementPeriodLte |
MeasurementPeriodLteMdt |
C |
0..1 |
This IE shall be present if available. When present, it shall contain the measurement period that should be used for the Data Volume and Scheduled IP Throughput measurements in LTE. |
areaScope |
AreaScope |
O |
0..1 |
When present, this IE shall contain the area in Cells or Tracking Areas where the MDT data collection shall take place, see 3GPP TS 32.422 [30]. |
positioningMethod |
PositioningMethodMdt |
O |
0..1 |
When present, it shall indicate the positioning method that shall be used for the MDT job in LTE. |
addPositioningMethodList |
array(PositioningMethodMdt) |
O |
1..N |
This IE may be present if positioningMethod IE is present. When present, it shall indicate a list of the additional positioning methods that shall be used for the MDT job |
mdtAllowedPlmnIdList |
array(PlmnId) |
O |
1..16 |
When present, this IE shall contain the PLMNs related to MDT. |
sensorMeasurementList |
array(SensorMeasurement) |
C |
1..N |
This IE shall be present if available. When present, this IE shall include a list the sensor measurements to be collected for UE in NR if they are available. |
6.1.6.2.59 Type: V2xInformation
Table 6.1.6.2.59-1: Definition of type V2xInformation
Attribute name |
Data type |
P |
Cardinality |
Description |
n2Pc5Pol |
N2InfoContent |
C |
0..1 |
This IE shall be present if N2 PC5 policy should be transferred. When present, the IE contains the NGAP V2X related IEs specified in clause 9.3.1.150 of 3GPP TS 38.413 [12]. |
6.1.6.2.60 Type: EpsNasSecurityMode
Table 6.1.6.2.60-1: Definition of type EpsNasSecurityMode
Attribute name |
Data type |
P |
Cardinality |
Description |
integrityAlgorithm |
EpsNasIntegrityAlgorithm |
M |
1 |
Indicates the integrity protection algorithm for EPS NAS |
cipheringAlgorithm |
EpsNasCipheringAlgorithm |
M |
1 |
Indicates the ciphering algorithm for EPS NAS. |
6.1.6.2.61 Type: UeContextRelocateData
Table 6.1.6.2.61-1: Definition of type UeContextRelocateData
Attribute name |
Data type |
P |
Cardinality |
Description |
Applicability |
ueContext |
UeContext |
M |
1 |
Represents an individual ueContext resource to be relocated. |
|
targetId |
NgRanTargetId |
M |
1 |
Represents the identification of target RAN |
|
sourceToTargetData |
N2InfoContent |
M |
1 |
This IE shall be included to contain the "Source to Target Transparent Container". |
|
forwardRelocationRequest |
RefToBinaryData |
M |
1 |
This IE shall be present, and it shall contain the reference to the binary data carrying the Forward Relocation Request message (see clause 6.1.6.4). |
|
pduSessionList |
array(N2SmInformation) |
C |
1..N |
This IE shall contain the list of N2SmInformation, where each N2SmInformation includes a PDU Session Resource Setup Request Transfer IE (see clause 9.3.4.1 of 3GPP TS 38.413 [24]) received from the SMF(s) per PDU session ID. |
|
ueRadioCapability |
N2InfoContent |
C |
0..1 |
This IE shall be included to contain the "UE Radio Capability Information" if available. |
|
ngapCause |
NgApCause |
C |
0..1 |
This IE shall be present, if available. When present, it shall represent the NGAP Cause mapped from the received S1-AP cause from the source E-UTRAN. Refer to 3GPP TS 29.010 [50] for the mapping of cause values between S1AP and NGAP. |
|
supportedFeatures |
SupportedFeatures |
C |
0..1 |
This IE shall be present if at least one optional feature defined in clause 6.1.8 is supported. |
6.1.6.2.62 Type: UeContextRelocatedData
Table 6.1.6.2.62-1: Definition of type UeContextRelocatedData
Attribute name |
Data type |
P |
Cardinality |
Description |
ueContext |
UeContext |
M |
1 |
Represents an individual ueContext resource relocated to a new AMF. |
6.1.6.2.63 Void
6.1.6.2.64 Type: EcRestrictionDataWb
Table 6.1.6.2.64-1: Definition of type EcRestrictionData
Attribute name |
Data type |
P |
Cardinality |
Description |
ecModeARestricted |
boolean |
O |
0..1 |
If present, indicates whether Enhanced Coverage Mode A is restricted or not. true: Enhanced Coverage Mode A is restricted. false or absent: Enhanced Coverage Mode A is not restricted. |
ecModeBRestricted |
boolean |
M |
1 |
This IE indicates whether Enhanced Coverage Mode B is restricted or not. true: Enhanced Coverage Mode B is restricted. false: Enhanced Coverage Mode B is not restricted. |
6.1.6.2.65 Type: ExtAmfEventSubscription
Table 6.1.6.2.65-1: Definition of type ExtAmfEventSubscription as a list of to be combined data types
Data type |
Cardinality |
Description |
Applicability |
AmfEventSubscription |
1 |
AMF event subscription |
|
AmfEventSubscriptionAddInfo |
1 |
Additional information for the AMF event subscription, e.g. Binding Indications, NF type of the NF that created the subscription. |
6.1.6.2.66 Type: AmfEventSubscriptionAddInfo
Table 6.1.6.2.66-1: Definition of type AmfEventSubscriptionAddInfo
Attribute name |
Data type |
P |
Cardinality |
Description |
bindingInfo |
array(string) |
O |
1..2 |
Binding indications received for event notifications (i.e. with "callback" scope) or for subscription change event notifications (i.e. with "subscription-events" scope) for an AMF event subscription. When present, entries of the array shall be set to the value of the 3gpp-Sbi-Binding header defined in clause 5.2.3.2.6 of 3GPP TS 29.500 [4], without the header name. Example of an array entry: "bl= nf-set; nfset=set1.udmset.5gc.mnc012.mcc345; servname=nudm-ee;scope=subscription-events" |
subscribingNfType |
NFType |
C |
0..1 |
This IE should be present if the information is available. When present, it shall contain the NF type of the NF that created the subscription. (NOTE X) |
eventSyncInd |
boolean |
C |
0..1 |
This IE should be present with value "true" when the event subscription shall be synchronized with UDM during EPS to 5GS mobility registration procedure, as specified in clause 5.3.2.4.2. When present, this IE shall be set as following: – true: the event subscription shall be synchronized with UDM. – false: the event subscription shall not be synchronized with UDM. |
nfConsumerInfo |
array(string) |
C |
1..N |
When present, this IE shall contain the NF Service Consumer information received together with the AMF event subscription and entries of the array shall be set to the value of the 3gpp-Sbi-Consumer-Info header defined in clause 5.2.3.3.7 of 3GPP TS 29.500 [4], without the header name. |
aoiStateList |
map(AreaOfInterestEventState) |
O |
1..N |
Map of subscribed Area of Interest (AoI) Event State in the old AMF. For the subscribed AoI Event(s), the JSON pointer to an AmfEventArea element in the areaList IE (or a PresenceInfo element in presenceInfoList IE) of the AmfEvent data type (see clause 6.2.6.2.3) shall be the key of the map. (NOTE 2) |
NOTE 1: In scenarios where an "intermediate NF" (e.g. UDM) creates a subscription on behalf of a "source NF" (e.g. NEF), this IE shall contain the NF type of the "intermediate NF". The NF type of the "source NF" may be available in the AmfEventSubscription. NOTE 2: The new AMF may use the information to determine whether the UE presence state in the AOI(s) has changed, thus should be reported to the NF consumer. |
6.1.6.2.67 Type: UeContextCancelRelocateData
Table 6.1.6.2.67-1: Definition of type UeContextCancelRelocateData
Attribute name |
Data type |
P |
Cardinality |
Description |
supi |
Supi |
C |
0..1 |
This IE shall be present if the UE is emergency registered and the SUPI is not authenticated. |
relocationCancelRequest |
RefToBinaryData |
M |
1 |
This IE shall be present, and it shall contain the reference to the binary data carrying the GTP-C Relocation Cancel Request message (see clause 6.1.6.4). |
6.1.6.2.68 Type: UeDifferentiationInfo
Table 6.1.6.2.68-1: Definition of type UeDifferentiationInfo
Attribute name |
Data type |
P |
Cardinality |
Description |
periodicComInd |
PeriodicCommunicationIndicator |
O |
0..1 |
This IE indicates whether the UE communicates periodically or not, e.g. only on demand. |
periodicTime |
DurationSec |
O |
0..1 |
This IE indicates the interval time of periodic communication (see TS 23.502 [3] clause 4.15.6.3). |
scheduledComTime |
ScheduledCommunicationTime |
O |
0..1 |
This IE indicates time and day of the week when the UE is available for communication (see TS 23.502 [3] clause 4.15.6.3). |
stationaryInd |
StationaryIndication |
O |
0..1 |
This IE indicates whether the UE is stationary or mobile (see TS 23.502 [3] clause 4.15.6.3). |
trafficProfile |
TrafficProfile |
O |
0..1 |
This IE indicates the type of data transmission: single packet transmission (UL or DL), dual packet transmission (UL with subsequent DL or DL with subsequent UL), multiple packets transmission |
batteryInd |
BatteryIndication |
O |
0..1 |
This IE indicates the power consumption type(s) of the UE (see TS 23.502 [3] clause 4.15.6.3). |
validityTime |
DateTime |
O |
0..1 |
When present, this IE identifies when the expected UE behaviour parameters expire and shall be deleted locally if it expire (see TS 23.502 [3] clause 4.15.6.3). When absent, no expiry for the expected UE behaviour parameters applies. |
6.1.6.2.69 Type: CeModeBInd
Table 6.1.6.2.69-1: Definition of type CeModeBInd
Attribute name |
Data type |
P |
Cardinality |
Description |
ceModeBSupportInd |
boolean |
M |
1 |
This IE shall contain the CE-mode-B Support Indicator (See 3GPP TS 38.413 [12], clause 9.3.1.156). This IE shall be set as follows: – true: CE-mode-B is supported; – false: CE-mode-B is not supported. |
6.1.6.2.70 Type: LteMInd
Table 6.1.6.2.70-1: Definition of type LteMInd
Attribute name |
Data type |
P |
Cardinality |
Description |
lteCatMInd |
boolean |
M |
1 |
This IE shall contain the LTE-M Indication (See 3GPP TS 38.413 [12], clause 9.3.1.157). This IE shall be set as follows: – true: LTE-M is indicated by the UE; – false: LTE-M is not indicated by the UE. |
6.1.6.2.71 Type: NpnAccessInfo
Table 6.1.6.2.71-1: Definition of type NpnAccessInfo
Attribute name |
Data type |
P |
Cardinality |
Description |
cellCagInfo |
array(CagId) |
O |
1..N |
This IE shall contain the CAG List of the CAG cell. |
6.1.6.2.72 Type: ProseContext
Table 6.1.6.2.72-1: Definition of type ProseContext
Attribute name |
Data type |
P |
Cardinality |
Description |
directDiscovery |
UeAuth |
C |
0..1 |
This IE shall be present if the UE is authorized to use the NR sidelink for the ProSe Direct Discovery service. |
directComm |
UeAuth |
C |
0..1 |
This IE shall be present if the UE is authorized to use the NR sidelink for the ProSe Direct Communication service. |
l2Relay |
UeAuth |
C |
0..1 |
This IE shall be present if the UE is authorized to act as a Layer-2 ProSe UE-to-Network Relay for the ProSe service. |
l3Relay |
UeAuth |
C |
0..1 |
This IE shall be present if the UE is authorized to act as a Layer-3 ProSe UE-to-Network Relay for the ProSe service. |
l2Remote |
UeAuth |
C |
0..1 |
This IE shall be present if the UE is authorized to act as a Layer-2 Remote UE for the ProSe service. |
nrUePc5Ambr |
BitRate |
C |
0..1 |
This IE shall be present if the UE is authorized to use the NR sidelink for the ProSe services. When present, this IE contains the ProSe NR UE-PC5-AMBR. |
pc5QoSPara |
Pc5QoSPara |
C |
0..1 |
This IE shall be present if the UE is authorized to use the NR sidelink for the ProSe services. When present, this IE contains policy data on the PC5 QoS parameters for the ProSe services on the NR sidelink. |
6.1.6.2.73 Type: AnalyticsSubscription
Table 6.2.6.2.73-1: Definition of type AnalyticsSubscription
Attribute name |
Data type |
P |
Cardinality |
Description |
nwdafId |
NfInstanceId |
C |
0..1 |
This IE shall be present, if available. When present, this IE shall contain the NF Instance ID of the NWDAF. (NOTE). |
nwdafSetId |
NfSetId |
C |
0..1 |
This IE shall be present, if available. When present, this IE shall contain the NF Set ID of the NWDAF. (NOTE). |
nwdafSubscriptionList |
array(NwdafSubscription) |
M |
1..N |
List of NWDAF subscriptions identified by subscription Id. |
NOTE: At least one nwdafId or nwdafSetId shall be included. |
6.1.6.2.74 Type: NwdafSubscription
Table 6.2.6.2.74-1: Definition of type NwdafSubscription
Attribute name |
Data type |
P |
Cardinality |
Description |
nwdafEvtSubsServiceUri |
Uri |
M |
1 |
It identifies the resource URI of the individual NWDAF subscription. |
nwdafEventsSubscription |
NnwdafEventsSubscription |
M |
1 |
The created Individual NWDAF Event Subscription resource |
6.1.6.2.75 Type: UpdpSubscriptionData
Table 6.1.6.2.75-1: Definition of type UpdpSubscriptionData
Attribute name |
Data type |
P |
Cardinality |
Description |
updpNotifySubscriptionId |
string |
M |
1 |
Represents the Id created by the AMF for the subscription to notify a UE policy delivery related N1 information. |
updpNotifyCallbackUri |
Uri |
M |
1 |
This IE represents the callback URI on which the UE policy delivery related N1 message shall be notified. |
supportedFeatures |
SupportedFeatures |
C |
0..1 |
This IE shall be present if at least one optional feature defined in clause 6.1.8 is supported by the NF service consumer. |
updpCallbackBinding |
string |
C |
0..1 |
This IE shall be present if Binding Indication was received for the PCF for the callback URI. When present, this IE shall contain the Binding indication of callback URI and shall be set to the value of the 3gpp-Sbi-Binding header defined in clause 5.2.3.2.6 of 3GPP TS 29.500 [4], without the header name. |
6.1.6.2.76 Type: ProSeInformation
Table 6.1.6.2.76-1: Definition of type ProSeInformation
Attribute name |
Data type |
P |
Cardinality |
Description |
n2Pc5ProSePol |
N2InfoContent |
M |
0..1 |
This attribute contains the N2 PC5 policy for 5G ProSe. This IE contains the NGAP ProSe related IEs specified in clause 9.3.1.234 of 3GPP TS 38.413 [12]. |
6.1.6.2.77 Type: ReleaseSessionInfo
Table 6.1.6.2.77-1: Definition of type ReleaseSessionInfo
Attribute name |
Data type |
P |
Cardinality |
Description |
releaseSessionList |
array(PduSessionId) |
M |
1..N |
This IE shall include the PDU session Id(s) to be released. |
releaseCause |
ReleaseCause |
M |
1 |
This IE shall include the cause to release the PDU session(s). |
6.1.6.2.78 Type: AreaOfInterestEventState
Table 6.1.6.2.78-1: Definition of type AreaOfInterestEventState
Attribute name |
Data type |
P |
Cardinality |
Description |
presence |
PresenceState |
M |
1 |
This IE shall contain the UE presence state for the indicated area of interest. |
individualPraIdList |
array(string) |
C |
1..N |
This IE shall be present if the indicated area of interest referring to a set of Core Network predefined Presence Reporting Areas and the UE is in at least one individual PRA within the set of Core Network predefined Presence Reporting Areas. When present, this IE shall contain the PRA Identifier of the individual PRA(s) where the UE is located. |
6.1.6.3 Simple data types and enumerations
6.1.6.3.1 Introduction
This clause defines simple data types and enumerations that can be referenced from data structures defined in the previous clauses.
6.1.6.3.2 Simple data types
The simple data types defined in table 6.1.6.3.2-1 shall be supported.
Table 6.1.6.3.2-1: Simple data types
Type Name |
Type Definition |
Description |
EpsBearerId |
integer |
Integer identifying an EPS bearer, within the range 0 to 15, as specified in clause 11.2.3.1.5, bits 5 to 8, of 3GPP TS 24.007 [15]. |
Ppi |
integer |
This represents the Paging Policy Indicator. The value is within the range 0 to 7. |
NasCount |
Uinteger |
Unsigned integer identifying the NAS COUNT as specified in 3GPP TS 33.501 [27] |
5GMmCapability |
Bytes |
String with format "byte" as defined in OpenAPI Specification [23], i.e. base64-encoded characters, encoding the "5GMM capability" IE as specified in clause 9.11.3.1 of 3GPP TS 24.501 [11] (starting from octet 1). |
UeSecurityCapability |
Bytes |
String with format "byte" as defined in OpenAPI Specification [23], i.e. base64-encoded characters, encoding the " UE security capability" IE as specified in clause 9.11.3.54 of 3GPP TS 24.501 [11] (starting from octet 1). |
S1UeNetworkCapability |
Bytes |
String with format "byte" as defined in OpenAPI Specification [23], i.e. base64-encoded characters, encoding the " S1 UE network capability" IE as specified in clause 9.11.3.48 of 3GPP TS 24.501 [11] (starting from octet 1). |
DrxParameter |
Bytes |
String with format "byte" as defined in OpenAPI Specification [23], i.e. base64-encoded characters, encoding the "5GS DRX Parameters" IE as specified in clause 9.11.3.2A of 3GPP TS 24.501 [11] (starting from octet 1). |
OmcIdentifier |
string |
The OMC Identifier indicates the identity of an Operation and Maintenance Centre to which Trace Records shall be sent. minLength: 1 maxLength: 20 |
MSClassmark2 |
Bytes |
String with format "byte" as defined in OpenAPI Specification [23], i.e. base64-encoded characters, encoding the Mobile Station Classmark 2 as specified in clause 9.11.3.31C of 3GPP TS 24.501 [11]) (starting from octet 1). |
SupportedCodec |
Bytes |
String with format "byte" as defined in OpenAPI Specification [23], i.e. base64-encoded characters, encoding the Supported Codec as specified in clause 9.11.3.51A of 3GPP TS 24.501 [11]) (starting from octet 1). |
6.1.6.3.3 Enumeration: StatusChange
Table 6.1.6.3.3-1: Enumeration StatusChange
Enumeration value |
Description |
"AMF_UNAVAILABLE" |
The AMF is unavailable to serve the UEs identified by the GUAMI(s). |
"AMF_AVAILABLE" |
The AMF is available to serve the UEs identified by the GUAMI(s). |
6.1.6.3.4 Enumeration: N2InformationClass
Table 6.1.6.3.4-1: Enumeration N2InformationClass
Enumeration value |
Description |
Applicability |
"SM" |
N2 SM information. |
|
"NRPPa" |
N2 NRPPa information. |
|
"PWS" |
N2 PWS information of PWS type. |
|
"PWS-BCAL" |
N2 Broadcast Completed Area List or the Broadcast Cancelled Area List. |
|
"PWS-RF" |
N2 Restart Indication or Failure Indication |
|
"RAN" |
N2 RAN related information. |
|
"V2X" |
N2 V2X information |
|
"PROSE" |
N2 5G ProSe information. |
ProSe |
6.1.6.3.5 Enumeration: N1MessageClass
Table 6.1.6.3.5-1: Enumeration N1MessageClass
Enumeration value |
Description |
"5GMM" |
The whole NAS message as received (for e.g. used in forwarding the Registration message to target AMF during Registration procedure with AMF redirection). |
"SM" |
N1 Session Management message |
"LPP" |
N1 LTE Positioning Protocol message |
"SMS" |
N1 SMS message as specified in 3GPP TS 23.040 [44] and 3GPP TS 24.011 [45] |
"UPDP" |
The N1 messages for UE Policy Delivery (See Annex D of 3GPP TS 24.501 [11]. |
"LCS" |
The N1 message of Location service message type |
6.1.6.3.6 Enumeration: N1N2MessageTransferCause
Table 6.1.6.3.6-1: Enumeration N1N2MessageTransferCause
Enumeration value |
Description |
"ATTEMPTING_TO_REACH_UE" |
This cause represents the case where the AMF has initiated paging to reach the UE in order to deliver the N1 message. |
"N1_N2_TRANSFER_INITIATED" |
This cause represents the case where the AMF has initiated the N1/N2 message transfer towards the UE and/or the AN. |
"WAITING_FOR_ASYNCHRONOUS_TRANSFER" |
This cause represents the case where the AMF has stored the N1/N2 message due to Asynchronous Transfer. |
"UE_NOT_RESPONDING" |
This cause represents the case that the AMF has initiated paging to reach the UE but the UE is not responding to the paging, or the case of a UE in RRC Inactive state when NG-RAN paging is not successful (e.g. NG-RAN initiated a UE context release with a cause indicating the non-delivery of the N1 message). |
"N1_MSG_NOT_TRANSFERRED" |
This cause represents the case where the AMF has skipped sending N1 message to the UE, when UE is in CM-IDLE and the "skipInd" is set to "true" in the request. |
"N2_MSG_NOT_TRANSFERRED" |
This cause indicates that the AMF has skipped sending the N2 message (i.e. PDU Session Resource Setup Request) as well as the possibly included N1 message to the 5G-AN, when the UE is in CM-CONNECTED state and the UE is outside of the validity area included in the N1N2MessageTransfer Request. |
"UE_NOT_REACHABLE_FOR_SESSION" |
This cause indicates that the UE is not reachable for the non-3GPP PDU session, due to the UE being in CM-IDLE for non-3GPP access and the PDU session is not allowed to move to 3GPP access. |
"TEMPORARY_REJECT_REGISTRATION_ONGOING" |
This cause represents the case that the AMF has initiated paging to reach the UE but there is an ongoing registration procedure. |
"TEMPORARY_REJECT_HANDOVER_ONGOING" |
This cause indicates that the AMF has initiated N1 signalling towards the UE but the N1 message could not be delivered due to an ongoing Xn or N2 handover procedure. |
"REJECTION_DUE_TO_PAGING_RESTRICTION" |
This cause represents the case that the UE has rejected the page as specified in 3GPP TS 23.501 [2] clause 5.38.4. |
"AN_NOT_RESPONDING" |
This cause indicates that the AMF has initiated a N2 request to transfer a N2 PDU (e.g. to setup, modify or release PDU session resources) but the AN is not responding to the N2 request. |
"FAILURE_CAUSE_UNSPECIFIED" |
This cause indicates that the N1/N2 message transfer failed due to unspecified reasons. |
6.1.6.3.7 Enumeration: UeContextTransferStatus
Table 6.1.6.3.7-1: Enumeration UeContextTransferStatus
Enumeration value |
Description |
"TRANSFERRED" |
Indicates a UE Context Transfer procedure is completed successful for the individual ueContext resource |
"NOT_TRANSFERRED" |
Indicates a UE Context Transfer procedure either did not complete successfully or the Registration request from the UE is redirected to another NF Service Consumer (e.g. AMF). |
6.1.6.3.8 Enumeration: N2InformationTransferResult
Table 6.1.6.3.8-1: Enumeration N2InformationTransferResult
Enumeration value |
Description |
"N2_INFO_TRANSFER_INITIATED" |
This cause code represents the case where the AMF has initiated the N2 information transfer towards the AN. |
6.1.6.3.9 Enumeration: CipheringAlgorithm
Table 6.1.6.3.9-1: Enumeration CipheringAlgorithm
Enumeration value |
Description |
"NEA0" |
Null ciphering algorithm |
"NEA1" |
128-bit SNOW 3G based algorithm |
"NEA2" |
128-bit AES based algorithm |
"NEA3" |
128-bit ZUC based algorithm |
6.1.6.3.10 Enumeration: IntegrityAlgorithm
Table 6.1.6.3.10-1: Enumeration IntegrityAlgorithm
Enumeration value |
Description |
"NIA0" |
Null Integrity Protection algorithm |
"NIA1" |
128-bit SNOW 3G based algorithm |
"NIA2" |
128-bit AES based algorithm |
"NIA3" |
128-bit ZUC based algorithm |
6.1.6.3.11 Enumeration: SmsSupport
Table 6.1.6.3.11-1: Enumeration SmsSupport
Enumeration value |
Description |
"3GPP" |
Support SMS delivery over NAS in 3GPP access |
"NON_3GPP" |
Support SMS delivery via non-3GPP access |
"BOTH" |
Support SMS delivery over NAS or via non-3GPP access |
"NONE" |
Don’t support SMS delivery |
6.1.6.3.12 Enumeration: ScType
Table 6.1.6.3.12-1: Enumeration ScType
Enumeration value |
Description |
"NATIVE" |
Native security context (for KSIAMF) |
"MAPPED" |
Mapped security context (for KSIASME) |
6.1.6.3.13 Enumeration: KeyAmfType
Table 6.1.6.3.13-1: Enumeration KeyAmfType
Enumeration value |
Description |
"KAMF" |
The Kamf value is sent. |
"KPRIMEAMF" |
The K’amf. value is sent. |
6.1.6.3.14 Enumeration: TransferReason
Table 6.1.6.3.14-1: Enumeration TransferReason
Enumeration value |
Description |
"INIT_REG" |
It indicates the AMF requests UE context for initial registration or disaster roaming initial registration. |
"MOBI_REG" |
It indicates the AMF requests UE context for mobility registration or disaster roaming mobility registration. |
"MOBI_REG_UE_VALIDATED" |
It indicates the AMF requests UE context for mobility registration or disaster roaming mobility registration of a validated UE. |
6.1.6.3.15 Enumeration: PolicyReqTrigger
Table 6.1.6.3.15-1: Enumeration PolicyReqTrigger
Enumeration value |
Description |
"LOCATION_CHANGE" |
The AM policy request shall be triggered when the UE’s location (Tracking Area) changes. |
"PRA_CHANGE" |
The AM policy request shall be triggered when the UE is entering / leaving a Presence Reporting Area. |
"ALLOWED_NSSAI_CHANGE" |
The policy request shall be triggered when the allowed NSSAI of the UE has changed. |
"NWDAF_DATA_CHANGE" |
The AM policy request shall be triggered when the NWDAF instance IDs used for the UE and/or associated Analytics IDs have changed. |
"PLMN_CHANGE" |
The UE policy request shall be triggered when the serving PLMN of UE has changed. |
"CON_STATE_CHANGE" |
The UE policy request shall be triggered when the connectivity state of UE has changed. |
"SMF_SELECT_CHANGE" |
The AM policy request shall be triggered when the UE request for an unsupported DNN or the UE request for a DNN within the list of DNN candidates for replacement per S-NSSAI. |
"ACCESS_TYPE_CHANGE" |
The AM policy request shall be triggered when the access type and the RAT type combinations available in the AMF for a UE with simultaneous 3GPP and non-3GPP connectivity have changed. |
6.1.6.3.16 Enumeration: RatSelector
Table 6.1.6.3.16-1: Enumeration RatSelector
Enumeration value |
Description |
"E-UTRA" |
The N2 information shall be transferred to ng-eNBs only. |
"NR" |
The N2 information shall be transferred to gNBs only. |
6.1.6.3.17 Enumeration: NgapIeType
Table 6.1.6.3.17-1: Enumeration NgapIeType
Enumeration value |
Description |
"PDU_RES_SETUP_REQ" |
PDU Session Resource Setup Request Transfer |
"PDU_RES_REL_CMD" |
PDU Session Resource Release Command Transfer |
"PDU_RES_MOD_REQ" |
PDU Session Resource Modify Request Transfer |
"HANDOVER_CMD" |
Handover Command Transfer |
"HANDOVER_REQUIRED" |
Handover Required Transfer |
"HANDOVER_PREP_FAIL" |
Handover Preparation Unsuccessful Transfer |
"SRC_TO_TAR_CONTAINER" |
Source to Target Transparent Container |
"TAR_TO_SRC_CONTAINER" |
Target to Source Transparent Container |
"TAR_TO_SRC_FAIL_CONTAINER" |
Target to Source Failure Transparent Container |
"RAN_STATUS_TRANS_CONTAINER" |
RAN Status Transfer Transparent Container |
"SON_CONFIG_TRANSFER" |
SON Configuration Transfer |
"NRPPA_PDU" |
NRPPa-PDU |
"UE_RADIO_CAPABILITY" |
UE Radio Capability |
"RIM_INFO_TRANSFER" |
RIM Information Transfer |
"SECONDARY_RAT_USAGE" |
Secondary RAT Data Usage Report Transfer |
"PC5_QOS_PARA" |
PC5 QoS Parameters |
"EARLY_STATUS_TRANS_CONTAINER" |
Early Status Transfer Transparent Container |
"UE_RADIO_CAPABILITY_FOR_PAGING" |
UE Radio Capability for Paging |
6.1.6.3.18 Enumeration: N2InfoNotifyReason
Table 6.1.6.3.18-1: Enumeration N2InfoNotifyReason
Enumeration value |
Description |
"HANDOVER_COMPLETED" |
Indicates that the N2 Information Notification is delivered when the handover procedure is completed successfully. |
6.1.6.3.19 Enumeration: SmfChangeIndication
Table 6.1.6.3.19-1: Enumeration SmfChangeIndication
Enumeration value |
Description |
"CHANGED" |
I-SMF or V-SMF changed. (NOTE 1) |
"REMOVED" |
I-SMF or V-SMF is removed. (NOTE 2) |
NOTE 1: This enumeration value shall also be used if the UE moves from HPLMN to a VPLMN, a V-SMF is inserted and the I-SMF is removed, or from VPLMN to HPLMN, an I-SMF is inserted and the V-SMF is removed. NOTE 2: This enumeration value shall also be used if the UE moves from VPLMN to HPLMN, without an I-SMF inserted in the HPLMN. |
6.1.6.3.20 Enumeration: SbiBindingLevel
Table 6.1.6.3.20-1: Enumeration SbiBindingLevel
Enumeration value |
Description |
"NF_INSTANCE_BINDING" |
Indicates binding to NF instance |
"NF_SET_BINDING" |
Indicates binding to NF Set |
"NF_SERVICE_SET_BINDING" |
Indicates binding to NF Service Set |
"NF_SERVICE_INSTANCE_BINDING" |
Indicates binding to NF Service instance |
6.1.6.3.21 Enumeration: EpsNasCipheringAlgorithm
This data type enumerates the algorithms for data ciphering in EPS NAS, as specified in clause 5.1.3.2 of 3GPP TS 33.401 [49].
Table 6.1.6.3.21-1: Enumeration EpsNasCipheringAlgorithm
Enumeration value |
Description |
"EEA0" |
Null ciphering algorithm |
"EEA1" |
128-bit SNOW 3G based algorithm |
"EEA2" |
128-bit AES based algorithm |
"EEA3" |
128-bit ZUC based algorithm |
6.1.6.3.22 Enumeration: EpsNasIntegrityAlgorithm
This data type enumerates the algorithms for data integrity protection in EPS NAS, as specified in clause 5.1.4.2 of 3GPP TS 33.401 [49].
Table 6.1.6.3.22-1: Enumeration EpsNasIntegrityAlgorithm
Enumeration value |
Description |
"EIA0" |
Null Integrity Protection algorithm |
"EIA1" |
128-bit SNOW 3G based algorithm |
"EIA2" |
128-bit AES based algorithm |
"EIA3" |
128-bit ZUC based algorithm |
6.1.6.3.23 Enumeration: PeriodicCommunicationIndicator
This data type enumerates types of Periodic Communication Indicator.
Table 6.1.6.3.23-1: Enumeration PeriodicCommunicationIndicator
Enumeration value |
Description |
"PIORIODICALLY" |
Periodically |
"ON_DEMAND" |
On demand |
6.1.6.3.24 Enumeration: UuaaMmStatus
This data type enumerates types of UUAA-MM status.
Table 6.1.6.3.24-1: Enumeration UuaaMmStatus
Enumeration value |
Description |
"SUCCESS" |
Success |
"PENDING" |
Pending |
"FAILED" |
Failed |
6.1.6.3.25 Enumeration: ReleaseCause
Table 6.1.6.3.25-1: Enumeration ReleaseCause
Enumeration value |
Description |
"SNPN_SNPN_MOBILITY" |
This cause represents the case where the continuity of the PDU Session(s) cannot be supported between networks due to SNPN-SNPN mobility. |
"NO_HR_AGREEMENT" |
This cause represents the case where the continuity of the PDU Session(s) cannot be supported between networks due to inter-PLMN mobility where no HR agreement exists. |
"UNSPECIFIED" |
This cause indicates that the continuity of the PDU Session(s) cannot be supported between networks due to unspecified reasons. |
6.1.6.4 Binary data
6.1.6.4.1 Introduction
This clause defines the binary data that shall be supported in a binary body part in an HTTP multipart message (see clauses 6.1.2.2.2 and 6.1.2.4).
Table 6.1.6.4.1-1: Binary Data Types
Name |
Clause defined |
Content type |
N1 Message |
6.1.6.4.2 |
vnd.3gpp.5gnas |
N2 Information |
6.1.6.4.3 |
vnd.3gpp.ngap |
Mobile Terminated Data |
6.1.6.4.3 |
vnd.3gpp.5gnas |
GTP-C message |
6.1.6.4.5 |
vnd.3gpp.gtpc |
6.1.6.4.2 N1 Message
N1 Message shall encode a 5GS NAS message of a specified type (e.g. SM, LPP) as specified in 3GPP TS 24.501 [11], using the vnd.3gpp.5gnas content-type.
N1 Message may encode e.g. the following 5GS NAS messages:
– For message class SM:
– PDU Session Modification Command (see clause 8.3.7 of 3GPP TS 24.501 [11]) during network initiated PDU session modification procedure (see clause 4.3.3 of 3GPP TS 23.502 [3]);
– PDU Session Release Command (see clause 8.3.12 of 3GPP TS 24.501 [11]) during network initiated PDU session release procedure (see clause 4.3.4 of 3GPP TS 23.502 [3]).
– PDU Session Establishment Accept (see clause 8.3.2 in 3GPP TS 24.501 [11]) during UE-requested PDU Session Establishment (see clause 4.3.2.2 in 3GPP TS 23.502 [3]).
– For message class LPP:
– UE Positioning Request messages as specified in 3GPP TS 36.355 [13] during UE assisted and UE based positioning procedure (see clause 6.11.1 of 3GPP TS 23.273 [42]).
– For message class 5GMM:
– REGISTRATION REQUEST message as specified in see clause 8.2.5 of 3GPP TS 24.501 [11], during registration procedures (see clause 4.2.2.2 of 3GPP TS 23.502 [3]).
– For message class UPDP:
– MANAGE UE POLICY COMMAND / MANAGE UE POLICY COMPLETE / MANAGE UE POLICY REJECT (see Annex D.5.1 to Annex D.5.3 of 3GPP TS 24.501 [11]) during network initiated UE policy management procedure (see Annex D.2.1 of 3GPP TS 24.501 [11]);
– UE STATE INDICATION (see Annex D.5.4 of 3GPP TS 24.501 [11]) during UE initiated UE state indication procedure (see Annex D.2.2 of 3GPP TS 24.501 [11]).
– UE POLICY PROVISIONING REQUEST / UE POLICY PROVISIONING REJECT (see clause 7.2 of 3GPP TS 24.587 [53]) during UE-requested V2X policy provisioning procedure and/or 5G ProSe policy provisioning procedure (see clause 5.3.2 of 3GPP TS 24.587 [53] and/or clause 5.3.2 of 3GPP TS 24.554 [54] respectively).
– For message class LCS:
– Location services messages between UE and LMF (lcs-PeriodicTriggeredInvoke/lcs-EventReport/lcs-CancelDeferredLocation) as specified in 3GPP TS 24.080 [43] during deferred 5GC-MT-LR procedure procedure (see clause 6.3 of 3GPP TS 23.273 [42]).
– For message class SMS:
– SMS payload information as specified in 3GPP TS 23.040 [44] and 3GPP TS 24.011 [45], e.g. CP-DATA, CP-ACK, CP-ERROR.
6.1.6.4.3 N2 Information
6.1.6.4.3.1 Introduction
N2 Information shall encode NG Application Protocol (NGAP) IEs, as specified in clause 9.4 of 3GPP TS 38.413 [12] (ASN.1 encoded), using the vnd.3gpp.ngap content-type.
6.1.6.4.3.2 NGAP IEs
For N2 information class SM, N2 Information may encode following NGAP SMF related IE specified in 3GPP TS 38.413 [12], as summarized in Table 6.1.6.4.3-1.
Table 6.1.6.4.3-1: N2 Information content for class SM
NGAP IE |
Reference (3GPP TS 38.413 [12]) |
Related NGAP message |
PDU Session Resource Setup Request Transfer |
9.3.4.1 |
PDU SESSION RESOURCE SETUP REQUEST |
PDU Session Resource Release Command Transfer |
9.3.4.12 |
PDU SESSION RESOURCE RELEASE COMMAND |
PDU Session Resource Modify Request Transfer |
9.3.4.3 |
PDU SESSION RESOURCE MODIFY REQUEST |
Handover Command Transfer |
9.3.4.10 |
HANDOVER COMMAND |
Handover Required Transfer |
9.3.4.14 |
HANDOVER REQUIRED |
Handover Preparation Unsuccessful Transfer |
9.3.4.18 |
HANDOVER COMMAND |
Secondary RAT Data Usage Report Transfer |
9.3.4.23 |
SECONDARY RAT DATA USAGE REPORT |
For N2 information class RAN, N2 Information may encode one of the following NGAP Transparent Container IEs specified in 3GPP TS 38.413 [12], as summarized in Table 6.1.6.4.3-2.
Table 6.1.6.4.3-2: N2 Information content for class RAN
NGAP IE |
Reference (3GPP TS 38.413 [12]) |
Related NGAP message |
Source to Target Transparent Container |
9.3.1.20 |
HANDOVER REQUIRED, HANDOVER REQUEST |
Target to Source Transparent Container |
9.3.1.21 |
HANDOVER COMMAND, HANDOVER REQUEST ACKNOWLEDGE |
Target to Source Failure Transparent Container |
9.3.1.186 |
HANDOVER FAILURE |
UE Radio Capability |
9.3.1.74 |
UE RADIO CAPABILITY INFO INDICATION. (NOTE 1). |
UE Radio Capability for Paging |
9.3.1.68 |
UE RADIO CAPABILITY INFO INDICATION. (NOTE 1). |
SON Configuration Transfer |
9.3.3.6 |
UPLINK RAN CONFIGURATION TRANSFER, DOWNLINK RAN CONFIGURATION TRANSFER |
RAN Status Transfer Transparent Container |
9.2.3.13, 9.2.3.14 |
UPLINK RAN STATUS TRANSFER, DOWNLINK RAN STATUS TRANSFER |
Early Status Transfer Transparent Container |
9.2.3.16, 9.2.3.17 |
UPLINK RAN EARLY STATUS TRANSFER DOWNLINK RAN EARLY STATUS TRANSFER |
RIM Information Transfer |
9.3.3.28 |
UPLINK RIM INFORMATION TRANSFER, DOWNLINK RIM INFORMATION TRANSFER |
NOTE 1: The AMF receives the UE Radio Capability and UE Radio Capability for Paging within a UE CAPABILITY INFO INDICATION message and then the AMF shall store the UE Radio Capability information and UE Radio Capability for Paging, and transfer them to the target AMF during an inter AMF mobility procedure. |
For N2 information class NRPPa, N2 Information may encode the following NGAP NRPPA Transport related IE specified in 3GPP TS 38.413 [12], as summarized in Table 6.1.6.4.3-3
Table 6.1.6.4.3-3: N2 Information content for class NRPPa
NGAP IE |
Reference (3GPP TS 38.413 [12]) |
Related NGAP message |
NRPPa-PDU |
9.3.3.14 |
DOWNLINK UE ASSOCIATED NRPPA TRANSPORT UPLINK UE ASSOCIATED NRPPA TRANSPORT DOWNLINK NON UE ASSOCIATED NRPPA TRANSPORT UPLINK NON UE ASSOCIATED NRPPA TRANSPORT |
For N2 information class V2X, N2 Information may encode the following V2X related IE specified in 3GPP TS 38.413 [12], as summarized in Table 6.1.6.4.3-4
Table 6.1.6.4.3-4: N2 Information content for class V2X
NGAP IE |
Reference (3GPP TS 38.413 [12]) |
Related NGAP message |
PC5 QoS Parameters |
9.3.1.150 |
INITIAL CONTEXT SETUP REQUEST UE CONTEXT MODIFICATION REQUEST HANDOVER REQUEST PATH SWITCH REQUEST ACKNOWLEDGE |
For N2 information class PROSE, N2 Information may encode the following ProSe related IE specified in 3GPP TS 38.413 [12], as summarized in Table 6.1.6.4.3-5
Table 6.1.6.4.3-5: N2 Information content for class PROSE
NGAP IE |
Reference (3GPP TS 38.413 [12]) |
Related NGAP message |
5G ProSe PC5 QoS Parameters |
9.3.1.234 |
INITIAL CONTEXT SETUP REQUEST UE CONTEXT MODIFICATION REQUEST HANDOVER REQUEST PATH SWITCH REQUEST ACKNOWLEDGE |
6.1.6.4.3.3 NGAP Messages
For N2 information class PWS, N2 Information shall encode NGAP Messages specified in 3GPP TS 38.413 [12].
Table 6.1.6.4.3.3-1: N2 PWS Request Information content
NGAP message |
Reference (3GPP TS 38.413 [12]) |
WRITE-REPLACE WARNING REQUEST |
9.2.8.1 |
PWS CANCEL REQUEST |
9.2.8.3 |
Table 6.1.6.4.3.3-2: N2 PWS Response Information content
NGAP message |
Reference (3GPP TS 38.413 [12]) |
WRITE-REPLACE WARNING RESPONSE |
9.2.8.2 |
PWS CANCEL RESPONSE |
9.2.8.4 |
N2 Information received by the AMF for PWS may be processed by the AMF before re-encoding and transferring to the Service Consumer.
If a subscription exists for N2InformationClass "PWS-BCAL" and the received N2 Message Type is a WRITE-REPLACE-WARNING-RESPONSE, then the AMF may aggregate the Broadcast Completed Area Lists it has received from the NG-RAN nodes for a message identified by its Serial Number and Message Identifier (see table 6.1.6.4.3-1) and transfer the ASN.1 (re-)encoded Message Type, Message Identifier, Serial Number and the (aggregated) Broadcast Completed Area List IE in the N2 Info Container in the N2InfoNotify, and the "bcEmptyAreaList" attribute if the Broadcast Completed Area List IE is not present in the PWS N2 information.
If a subscription exists for N2InformationClass "PWS-BCAL" and the received N2 Message Type is a PWS-CANCEL-RESPONSE, then the AMF may aggregate the Broadcast Cancelled Area Lists IE it has received from the NG-RAN nodes for a message identified by its Serial Number and Message Identifier (see table 6.1.6.4.3-1) and transfer the ASN.1 (re-)encoded the Message Type, Message Identifier, Serial Number, the (aggregated) Broadcast Cancelled Area List IE in the N2 Info Container in the N2InfoNotify, and the "bcEmptyAreaList" attribute if the PWS-CANCEL-RESPONSE does not contain a Broadcast Cancelled Area List, in the PWS N2 information.
For the ASN.1 definition for encoding the WRITE-REPLACE-WARNING-RESPONSE and the PWS-CANCEL-RESPONSE, see clause 9.4 of 3GPP TS 38.413 [12].
If a subscription exists for N2InformationClass "PWS-RF" and the received N2 Message Type is a PWS-RESTART-INDICATION, then the AMF may transfer the ASN.1 encoded string from the PWS-RESTART-INDICATION (see table 6.1.6.4.3-2) in the N2 Info Container in the N2InfoNotify.
If a subscription exists for N2InformationClass "PWS-RF" and the received N2 Message Type is a PWS-FAILURE-INDICATION (see table 6.1.6.4.3-2), then the AMF may transfer the ASN1 encoded string from the PWS-FAILURE-INDICATION in the N2 Info Container in the N2InfoNotify.
Table 6.1.6.4.3.3-3: N2 PWS Indication Information content
NGAP message |
Reference (3GPP TS 38.413 [12]) |
PWS RESTART INDICATION |
9.2.8.5 |
PWS FAILURE INDICATION |
9.2.8.6 |
The Message Type shall be present and encoded as the first N2 PWS Indication IE in any NonUeN2InfoNotify for PWS messages to enable the receiver to decode the N2 PWS IEs.
For N2 information class RAN, N2 Information shall encode one of the following NGAP messages specified in 3GPP TS 38.413 [12], as summarized in Table 6.1.6.4.3.3-4.
Table 6.1.6.4.3.3-4: N2 Information content for class RAN
NGAP message |
Reference (3GPP TS 38.413 [12]) |
Any UE specific Uplink NGAP message |
6.1.6.4.4 Mobile Terminated Data
Mobile Terminated Data shall encode the user data to be sent by the AMF to the UE in the Payload Container specified in 3GPP TS 24.501 [7], using the vnd.3gpp.5gnas content-type, as summarized in Table 6.1.6.4.4-1.
Table 6.1.6.4.4-1: Mobile Terminated Data
Mobile Terminated Data |
Reference (3GPP TS 24.501 [7]) |
Related NAS SM message |
Payload container contents in octets 4 to n |
9.11.3.39 |
DL NAS Transport |
6.1.6.4.5 GTP-C Message
GTP-C Message shall encode a GTP-C message of a specified type (e.g. Forward Relocation Request) as specified in 3GPP TS 29.274 [41], using the vnd.3gpp.gtpc content-type. The GTP-C message carried in the HTTP multipart message shall include the UDP/IP headers.
GTP-C Message may encode e.g. the following GTP-C messages:
– Mobility Management message:
– Forward Relocation Request (see clause 7.3.1 of 3GPP TS 29.274 [41]) during EPS to 5GS handover with AMF re-allocation procedure (see clause 4.11.1.2.2 of 3GPP TS 23.502 [3]);
– Relocation Cancel Request (see clause 7.3.16 of 3GPP TS 29.274 [41]) during EPS to 5GS handover with AMF re-allocation procedure (see clause 4.11.1.2.3 of 3GPP TS 23.502 [3]), if handover cancel is triggered.