ApplicationId

string

String providing an application identifier.

ApplicationIdRm

string

This data type is defined in the same way as the "ApplicationId" data type, but with the OpenAPI "nullable: true" property.

PduSessionId

integer

Unsigned integer identifying a PDU session, within the range 0 to 255, as specified in clause 11.2.3.1b, bits 1 to 8, of 3GPP TS 24.007 [13]. If the PDU Session ID is allocated by the Core Network for UEs not supporting N1 mode, reserved range 64 to 95 is used. PDU Session ID within the reserved range is only visible in the Core Network (NOTE).

Mcc

string

Mobile Country Code part of the PLMN, comprising 3 digits, as defined in clause 9.3.3.5 of 3GPP TS 38.413 [11].

Pattern: ‘^[0-9]{3}$’

MccRm

string

This data type is defined in the same way as the "Mcc" data type, but with the OpenAPI "nullable: true" property.

Mnc

string

Mobile Network Code part of the PLMN, comprising 2 or 3 digits, as defined in clause 9.3.3.5 of 3GPP TS 38.413 [11].

Pattern: ‘^[0-9]{2,3}$’

MncRm

string

This data type is defined in the same way as the "Mnc" data type, but with the OpenAPI "nullable: true" property.

Tac

string

2 or 3-octet string identifying a tracking area code as specified in clause 9.3.3.10 of 3GPP TS 38.413 [11], in hexadecimal representation. Each character in the string shall take a value of "0" to "9", "a" to "f" or "A" to "F" and shall represent 4 bits. The most significant character representing the 4 most significant bits of the TAC shall appear first in the string, and the character representing the 4 least significant bit of the TAC shall appear last in the string.

Examples:

A legacy TAC 0x4305 shall be encoded as "4305".

An extended TAC 0x63F84B shall be encoded as "63F84B"

TacRm

string

This data type is defined in the same way as the "Tac" data type, but with the OpenAPI "nullable: true" property.

EutraCellId

string

28-bit string identifying an E-UTRA Cell Id as specified in clause 9.3.1.9 of 3GPP TS 38.413 [11], in hexadecimal representation. Each character in the string shall take a value of "0" to "9", "a" to "f" or "A" to "F" and shall represent 4 bits. The most significant character representing the 4 most significant bits of the Cell Id shall appear first in the string, and the character representing the 4 least significant bit of the Cell Id shall appear last in the string.

Pattern: ‘^[A-Fa-f0-9]{7}$’

Example:

An E-UTRA Cell Id 0x5BD6007 shall be encoded as "5BD6007".

EutraCellIdRm

string

This data type is defined in the same way as the "EutraCellId" data type, but with the OpenAPI "nullable: true" property.

NrCellId

string

36-bit string identifying an NR Cell Id as specified in clause 9.3.1.7 of 3GPP TS 38.413 [11], in hexadecimal representation. Each character in the string shall take a value of "0" to "9", "a" to "f" or "A" to "F" and shall represent 4 bits. The most significant character representing the 4 most significant bits of the Cell Id shall appear first in the string, and the character representing the 4 least significant bit of the Cell Id shall appear last in the string.

Pattern: ‘^[A-Fa-f0-9]{9}$’

Example:

An NR Cell Id 0x225BD6007 shall be encoded as "225BD6007".

NrCellIdRm

string

This data type is defined in the same way as the "NrCellId" data type, but with the OpenAPI "nullable: true" property.

Dnai

string

DNAI (Data network access identifier), see clause 5.6.7 of 3GPP TS 23.501 [8].

DnaiRm

string

This data type is defined in the same way as the "Dnai" data type, but with the OpenAPI "nullable: true" property.

5GMmCause

Uinteger

This represents the 5GMM cause code values as specified in 3GPP TS 24.501 [20].

AreaCodeRm

string

This data type is defined in the same way as the "AreaCode" data type, but with the OpenAPI "nullable: true" property.

AmfName

Fqdn

FQDN (Fully Qualified Domain Name) of the AMF as defined in clause 28.3.2.5 of 3GPP TS 23.003 [7].

AreaCode

string

Values are operator specific.

N3IwfId

string

This represents the identifier of the N3IWF ID as specified in clause 9.3.1.57 of 3GPP TS 38.413 [11] in hexadecimal representation. Each character in the string shall take a value of "0" to "9", "a" to "f" or "A" to "F" and shall represent 4 bits. The most significant character representing the 4 most significant bits of the N3IWF ID shall appear first in the string, and the character representing the 4 least significant bit of the N3IWF ID shall appear last in the string.

Pattern: ‘^[A-Fa-f0-9]+$’

Example:

The N3IWF Id 0x5BD6 shall be encoded as "5BD6".

WAgfId

string

This represents the identifier of the W-AGF ID as specified in clause 9.3.1.162 of 3GPP TS 38.413 [11] in hexadecimal representation. Each character in the string shall take a value of "0" to "9", "a" to "f" or "A" to "F" and shall represent 4 bits. The most significant character representing the 4 most significant bits of the W-AGF ID shall appear first in the string, and the character representing the 4 least significant bit of the W-AGF ID shall appear last in the string.

Pattern: ‘^[A-Fa-f0-9]+$’

Example:

The W-AGF Id 0x5BD6 shall be encoded as "5BD6".

TngfId

string

This represents the identifier of the TNGF ID as specified in clause 9.3.1.161 of 3GPP TS 38.413 [11] in hexadecimal representation. Each character in the string shall take a value of "0" to "9", "a" to "f" or "A" to "F" and shall represent 4 bits. The most significant character representing the 4 most significant bits of the TNGF ID shall appear first in the string, and the character representing the 4 least significant bit of the TNGF ID shall appear last in the string.

Pattern: ‘^[A-Fa-f0-9]+$’

Example:

The TNGF Id 0x5BD6 shall be encoded as "5BD6".

NgeNbId

string

This represents the identifier of the ng-eNB ID as specified in clause 9.3.1.8 of 3GPP TS 38.413 [11].

The string shall be formatted with following pattern:

Pattern: ‘^(‘MacroNGeNB-[A-Fa-f0-9]{5}|

LMacroNGeNB-[A-Fa-f0-9]{6}|

SMacroNGeNB-[A-Fa-f0-9]{5})$’

The value of the ng-eNB ID shall be encoded in hexadecimal representation. Each character in the string shall take a value of "0" to "9", "a" to "f" or "A" to "F" and shall represent 4 bits. The padding 0 shall be added to make multiple nibbles, so the most significant character representing the padding 0 if required together with the 4 most significant bits of the ng-eNB ID shall appear first in the string, and the character representing the 4 least significant bit of the ng-eNB ID (to form a nibble) shall appear last in the string.

Examples:

" SMacroNGeNB-34B89" indicates a Short Macro NG-eNB ID with value 0x34B89.

Nid

string

This represents the Network Identifier, which together with a PLMN ID is used to identify an SNPN (see 3GPP TS 23.003 [7] and 3GPP TS 23.501 [8] clause 5.30.2.1).

Pattern: ‘^[A-Fa-f0-9]{11}$’

NidRm

string

This data type is defined in the same way as the "Nid" data type, but with the OpenAPI "nullable: true" property.

NfSetId

string

NF Set Identifier (see clause 28.12 of 3GPP TS 23.003 [7]), formatted as the following string:

" set<Set ID>.<nftype>set.5gc.mnc<MNC>.mcc<MCC>", or

"set<SetID>.<NFType>set.5gc.nid<NID>.mnc<MNC>.mcc<MCC>"

with

<MCC> encoded as defined in clause 5.4.2 ("Mcc" data type definition)

<MNC> encoding the Mobile Network Code part of the PLMN, comprising 3 digits. If there are only 2 significant digits in the MNC, one "0" digit shall be inserted at the left side to fill the 3 digits coding of MNC. Pattern: ‘^[0-9]{3}$

<NFType> encoded as a value defined in Table 6.1.6.3.3-1 of 3GPP TS 29.510 [29] but with lower case characters

<Set ID> encoded as a string of characters consisting of alphabetic characters (A-Z and a-z), digits (0-9) and/or the hyphen (-) and that shall end with either an alphabetic character or a digit.

Pattern: ‘^([A-Za-z0-9\-]*[A-Za-z0-9])$’

Examples:
"setxyz.smfset.5gc.mnc012.mcc345"

"set12.pcfset.5gc.mnc012.mcc345"

NfServiceSetId

string

NF Service Set Identifier (see clause 28.12 of 3GPP TS 23.003 [7]) formatted as the following string:

" set<Set ID>.sn<Service Name>.nfi<NF Instance ID>.5gc.mnc<MNC>.mcc<MCC>">", or

"set<SetID>.sn<ServiceName>.nfi<NFInstanceID>.5gc.nid<NID>.mnc<MNC>.mcc<MCC>"

with

<MCC> encoded as defined in clause 5.4.2 ("Mcc" data type definition)

<MNC> encoding the Mobile Network Code part of the PLMN, comprising 3 digits. If there are only 2 significant digits in the MNC, one "0" digit shall be inserted at the left side to fill the 3 digits coding of MNC. Pattern: ‘^[0-9]{3}$’

<NID> encoded as defined in clause 5.4.2 ("Nid" data type definition)

<NFInstanceId> encoded as defined in clause 5.3.2

<ServiceName> encoded as defined in 3GPP TS 29.510 [29]

<Set ID> encoded as a string of characters consisting of alphabetic characters (A-Z and a-z), digits (0-9) and/or the hyphen (-) and that shall end with either an alphabetic character or a digit.

Pattern: ‘^([A-Za-z0-9\-]*[A-Za-z0-9])$

Examples:

"setxyz.snnsmf-pdusession.nfi54804518-4191-46b3-955c-ac631f953ed8.5gc.mnc012.mcc345"

"set2.snnpcf-smpolicycontrol.nfi54804518-4191-46b3-955c-ac631f953ed8.5gc.mnc012.mcc345"

PlmnAssiUeRadioCapId

Bytes

String with format "byte" as defined in OpenAPI Specification [3], i.e. base64-encoded characters, encoding the "UE radio capability ID" IE as specified in clause 9.11.3.68 of 3GPP TS 24.501 [20] (starting from octet 1).

ManAssiUeRadioCapId

Bytes

String with format "byte" as defined in OpenAPI Specification [3], i.e. base64-encoded characters, encoding the "UE radio capability ID" IE as specified in clause 9.11.3.68 of 3GPP TS 24.501 [20] (starting from octet 1).

TypeAllocationCode

string

Type Allocation Code (TAC) of the UE, comprising the initial eight-digit portion of the 15-digit IMEI and 16-digit IMEISV codes. See clause 6.2 of 3GPP TS 23.003 [7].

Pattern: ‘^[0-9]{8}$’

HfcNId

string

This IE represents the identifier of the HFC node Id as specified in CableLabs WR-TR-5WWC-ARCH [32]. It is provisioned by the wireline operator as part of wireline operations and may contain up to six characters.

HfcNIdRm

string

This data type is defined in the same way as the "HfcNId" data type, but with the OpenAPI "nullable: true" property.

ENbId

string

This represents the identifier of the eNB ID as specified in clause 9.2.1.37 of 3GPP TS 36.413 [16].

The string shall be formatted with following pattern:

Pattern: ‘^(‘MacroeNB-[A-Fa-f0-9]{5}|LMacroeNB-[A-Fa-f0-9]{6}|SMacroeNB-[A-Fa-f0-9]{5}|HomeeNB-[A-Fa-f0-9]{7})$’

The value of the eNB ID shall be encoded in hexadecimal representation. Each character in the string shall take a value of "0" to "9", "a" to "f" or "A" to "F" and shall represent 4 bits. The padding 0 shall be added to make multiple nibbles, so the most significant character representing the padding 0 if required together with the 4 most significant bits of the eNB ID shall appear first in the string, and the character representing the 4 least significant bit of the eNB ID (to form a nibble) shall appear last in the string.

Examples:

"SMacroeNB-34B89" indicates a Short Macro eNB ID with value 0x34B89.

Gli

Bytes

Global Line Identifier uniquely identifying the line connecting the 5G-BRG or FN-BRG to the 5GS. See clause 28.16.3 of 3GPP TS 23.003 [7].

This shall be encoded as a string with format "byte" as defined in OpenAPI Specification [3], i.e. base64-encoded characters, representing the GLI value (up to 150 bytes) encoded as specified in BBF WT-470 [37].

Gci

string

Global Cable Identifier uniquely identifying the connection between the 5G-CRG or FN-CRG to the 5GS. See clause 28.15.4 of 3GPP TS 23.003 [7].

This shall be encoded as a string per clause 28.15.4 of 3GPP TS 23.003 [7], and compliant with the syntax specified in clause 2.2 of IETF RFC 7542 [47] for the username part of a NAI. The GCI value is specified in CableLabs WR-TR-5WWC-ARCH [32].

NsSrg

string

String representing Network Slice Simultaneous Registration Group (see clause 5.15.12 of 3GPP TS 23.501 [8])

NsSrgRm

string

This data type is defined in the same way as the " NsSrg" data type, but with the OpenAPI "nullable: true" property.

RelayServiceCode

integer

Relay Service Code to identify a connectivity service provided by the UE-to-Network relay.

Integer type as defined in OpenAPI Specification [3], with value range from 0 to 16777215 (decimal).

Minimum = 0. Maximum = 16777215.

5GPrukId

string

Prose Remote User Key ID over Control Plane

A string carrying the CP-PRUK ID of the remote UE as specified in 3GPP TS 33.503 [50].

The CP-PRUK ID is a string in NAI format as specified in clause 28.7.11 of 3GPP TS 23.003 [7].

pattern: "^rid[0-9]{1,4}\.pid[0-9a-fA-F]+\@prose-cp\.5gc\.mnc[0-9]{2,3}\.mcc[0-9]{3}\.3gppnetwork\.org$"

NsagId

integer

Containing a Network Slice AS Group ID, see 3GPP TS 38.413 [11].

Values between 0 and 255 are allowed for this data type in this release.

NsagIdRm

integer

This data type is defined in the same way as the "NsagId" data type, but with the OpenAPI "nullable: true" property.

NOTE: For a PDN connection established via MME, the PDU Session ID value is set to 64 plus the EPS bearer ID of the default EPS bearer of the PDN connection; for a PDN connection established via ePDG, the PDU Session ID value is set to 80 plus the EPS bearer ID of the default EPS bearer of the PDN connection.

"3GPP_ACCESS"

3GPP access

"NON_3GPP_ACCESS"

Non-3GPP access

"NR"

New Radio

"EUTRA"

(WB) Evolved Universal Terrestrial Radio Access

"WLAN"

Untrusted Wireless LAN (IEEE 802.11) access

"VIRTUAL"

Virtual (see NOTE 1)

"NBIOT"

NB IoT

"WIRELINE"

Wireline access

"WIRELINE_CABLE"

Wireline Cable access

"WIRELINE_BBF"

Wireline BBF access

"LTE-M"

LTE-M (see NOTE 2)

"NR_U"

New Radio in unlicensed bands

"EUTRA_U"

(WB) Evolved Universal Terrestrial Radio Access in unlicensed bands

"TRUSTED_N3GA"

Trusted Non-3GPP access

"TRUSTED_WLAN"

Trusted Wireless LAN (IEEE 802.11) access

"UTRA"

UMTS Terrestrial Radio Access

"GERA"

GSM EDGE Radio Access Network

"NR_LEO"

NR (LEO) satellite access type

"NR_MEO"

NR (MEO) satellite access type

"NR_GEO"

NR (GEO) satellite access type

"NR_OTHER_SAT"

NR (OTHERSAT) satellite access type

"NR_REDCAP"

NR RedCap access type (see NOTE 3)

NOTE 1: Virtual shall be used if the N3IWF does not know the access technology used for an untrusted non-3GPP access.

NOTE 2: This RAT type value is used only in the Core Network; it shall be used when a Category M UE using E-UTRA has provided a Category M indication to the NG-RAN.

NOTE 3: This RAT type value is used only in the Core Network; it shall be used only for an UE using NR with reduced radio capability provided to the NG-RAN.

"IPV4"

IPv4

"IPV6"

IPv6

"IPV4V6"

IPv4v6 (see clause 5.8.2.2.1 of 3GPP TS 23.501 [8])

"UNSTRUCTURED"

Unstructured

"ETHERNET"

Ethernet

"REQUIRED"

UP integrity protection shall apply for all the traffic on the PDU Session.

"PREFERRED"

UP integrity protection should apply for all the traffic on the PDU Session.

"NOT_NEEDED"

UP integrity protection shall not apply on the PDU Session.

"REQUIRED"

UP confidentiality protection shall apply for all the traffic on the PDU Session.

"PREFERRED"

UP confidentiality protection should apply for all the traffic on the PDU Session.

"NOT_NEEDED"

UP confidentiality protection shall not apply on the PDU Session.

"SSC_MODE_1"

see 3GPP TS 23.501 [8]

"SSC_MODE_2"

see 3GPP TS 23.501 [8]

"SSC_MODE_3"

see 3GPP TS 23.501 [8]

EARLY

Early notification of UP path reconfiguration.

EARLY_LATE

Early and late notification of UP path reconfiguration. This value shall only be present in the subscription to the DNAI change event.

LATE

Late notification of UP path reconfiguration.

"ALLOWED_AREAS"

This value indicates that areas are allowed.

"NOT_ALLOWED_AREAS"

This value indicates that areas are not allowed.

"5GC"

5G Core

"EPC"

Evolved Packet Core

"IN_AREA"

Indicates that the UE is inside or enters the presence reporting area.

"OUT_OF_AREA"

Indicates that the UE is outside or leaves the presence reporting area.

"UNKNOWN"

Indicates it is unknown whether the UE is in the presence reporting area or not.

"INACTIVE"

Indicates that the presence reporting area is inactive in the serving node.

"STATIONARY"

Identifies the UE is stationary

"MOBILE"

Identifies the UE is mobile

"DOWNLINK_ONLY"

Downlink only

"UPLINK_ONLY"

Uplink only

"BIDIRECTIONAL"

Bi-directional

"SINGLE_TRANS_UL"

Uplink single packet transmission.

"SINGLE_TRANS_DL"

Downlink single packet transmission.

"DUAL_TRANS_UL_FIRST"

Dual packet transmission, firstly uplink packet transmission with subsequent downlink packet transmission.

"DUAL_TRANS_DL_FIRST"

Dual packet transmission, firstly downlink packet transmission with subsequent uplink packet transmission.

"MULTI_TRANS"

Multiple packet transmission.

"LOCATION_ALLOWED_WITH_NOTIFICATION"

Location allowed with notification

"LOCATION_ALLOWED_WITHOUT_NOTIFICATION"

Location allowed without notification

"LOCATION_ALLOWED_WITHOUT_RESPONSE"

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

"LOCATION_RESTRICTED_WITHOUT_RESPONSE"

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

"NOTIFICATION_ONLY"

Notification only

"NOTIFICATION_AND_VERIFICATION_ONLY"

Notification and privacy verification only

"AUTHORIZED"

Indicates that the UE is authorized.

"NOT_AUTHORIZED"

Indicates that the UE is not authorized.

"BUFFERED"

The first downlink data is buffered with extended buffering matching the source of the downlink traffic.

"TRANSMITTED"

The first downlink data matching the source of the downlink traffic is transmitted after previous buffering or discarding of corresponding packet(s) because the UE of the PDU Session becomes ACTIVE, and buffered data can be delivered to UE.

"DISCARDED"

The first downlink data matching the source of the downlink traffic is discarded because the Extended Buffering time, as determined by the SMF, expires or the amount of downlink data to be buffered is exceeded.

"EAP_SUCCESS"

The NSSAA status is EAP-Success.

"EAP_FAILURE"

The NSSAA status is EAP-Failure.

"PENDING"

The NSSAA status is Pending, i.e. the NSSAA procedure is ongoing.

"DSL"

DSL line

"PON"

PON line

ACTIVATE

The event notification is activated.

DEACTIVATE

The event notification is deactivated and shall be muted. The available event(s) shall be stored.

RETRIEVAL

The event notification shall be sent to the NF service consumer(s), after that, is muted again.

(See NOTE)

NOTE: The value "RETRIEVAL" shall not be provided during the creating subscription procedure.

"UDP"

User Datagram Protocol

"TCP"

Transmission Control Protocol

"GEO"

Indicates Geostationary satellite backhaul category.

"MEO"

Indicates Medium Earth Orbit satellite backhaul category.

"LEO"

Indicates Low Earth Orbit satellite backhaul category.

"OTHER_SAT"

Indicates other satellite backhaul category.

"NON_SATELLITE"

Indicates non satellite backhaul. (NOTE)

NOTE: This value indicates that there is no longer any satellite backhaul towards the 5G AN currently serving the UE.

5qi

5Qi

M

1

Default 5G QoS identifier see 3GPP TS 23.501 [8] clause 5.7.2.7.

arp

Arp

M

1

Default Allocation and Retention Priority see 3GPP TS23.501 [8] clause 5.7.2.7.

priorityLevel

5QiPriorityLevel

O

0..1

Defines the 5QI Priority Level.

When present, it contains the 5QI Priority Level value that overrides the standardized or pre-configured value as described in 3GPP TS 23.501 [8].

sst

Uinteger

M

1

Unsigned integer, within the range 0 to 255, representing the Slice/Service Type. It indicates the expected Network Slice behaviour in terms of features and services.

Values 0 to 127 correspond to the standardized SST range. Values 128 to 255 correspond to the Operator-specific range. See clause 28.4.2 of 3GPP TS 23.003 [7].

Standardized values are defined in clause 5.15.2.2 of 3GPP TS 23.501 [8].

sd

string

O

0..1

3-octet string, representing the Slice Differentiator, in hexadecimal representation. Each character in the string shall take a value of "0" to "9", "a" to "f" or "A" to "F" and shall represent 4 bits. The most significant character representing the 4 most significant bits of the SD shall appear first in the string, and the character representing the 4 least significant bit of the SD shall appear last in the string.

This is an optional parameter that complements the Slice/Service type(s) to allow to differentiate amongst multiple Network Slices of the same Slice/Service type. This IE shall be absent if no SD value is associated with the SST.

Pattern: ‘^[A-Fa-f0-9]{6}$’

mcc

Mcc

M

1

Mobile Country Code

mnc

Mnc

M

1

Mobile Network Code

plmnId

PlmnId

M

1

PLMN Identity

tac

Tac

M

1

Tracking Area Code

nid

Nid

O

0..1

Network Identifier, shall be present in case of SNPN, PlmnId together with Nid
indicates the identity of the SNPN to which the TA belongs to.

plmnId

PlmnId

M

1

PLMN Identity

eutraCellId

EutraCellId

M

1

E-UTRA Cell Identity

nid

Nid

O

0..1

Network Identifier

plmnId

PlmnId

M

1

PLMN Identity

nrCellId

NrCellId

M

1

NR Cell Identity

nid

Nid

C

0..1

Network Identifier, shall be present in case of SNPN, PlmnId together with Nid indicates the identity of the SNPN to which the NR cell belongs to.

eutraLocation

EutraLocation

C

0..1

E-UTRA user location (see NOTE).

nrLocation

NrLocation

C

0..1

NR user location (see NOTE).

n3gaLocation

N3gaLocation

C

0..1

Non-3GPP access user location (see NOTE).

utraLocation

UtraLocation

C

0..1

UTRAN access user location (see NOTE).

geraLocation

GeraLocation

C

0..1

GERAN access user location (see NOTE).

NOTE: At least one of eutraLocation, nrLocation, n3gaLocation, utraLocation and geraLocation shall be present. Several of them may be present.

tai

Tai

M

1

Tracking Area Identity.

The TAC of the TAI shall be set to one reserved value (e.g. 0x0000, see clause 19.4.2.3 of 3GPP TS 23.003 [7]) if the TAI information is not available.

ignoreTai

boolean

O

0..1

This flag when present shall indicate that the Tai shall be ignored.

When present, it shall be set as follows:

– true: tai shall be ignored.

– false (default): tai shall not be ignored.

ecgi

Ecgi

M

1

E-UTRA Cell Identity

ignoreEcgi

boolean

O

0..1

This flag when present shall indicate that the Ecgi shall be ignored.

When present, it shall be set as follows:

– true: ecgi shall be ignored.

– false (default): ecgi shall not be ignored.

ageOfLocationInformation

integer

O

0 1

The value represents the elapsed time in minutes since the last network contact of the mobile station.

Value "0" indicates that the location information was obtained after a successful paging procedure for Active Location Retrieval when the UE is in idle mode or after a successful NG-RAN location reporting procedure with the eNB when the UE is in connected mode.

Any other value than "0" indicates that the location information is the last known one.

See 3GPP TS 29.002 [21] clause 17.7.8.

ueLocationTimestamp

DateTime

O

0..1

The value represents the UTC time when the UeLocation information was acquired.

geographicalInformation

string

O

0..1

Refer to geographical Information.

See 3GPP TS 23.032 [23] clause 7.3.2. Only the description of an ellipsoid point with uncertainty circle is allowed to be used.

Allowed characters are 0-9 and A-F;

geodeticInformation

string

O

0..1

Refers to Calling Geodetic Location.

See ITU-T Recommendation Q.763 (1999) [24] clause 3.88.2. Only the description of an ellipsoid point with uncertainty circle is allowed to be used.

Allowed characters are 0-9 and A-F.

globalNgenbId

GlobalRanNodeId

O

0..1

It indicates the global identity of the ng-eNodeB in which the UE is currently located.

See 3GPP TS 38.413 [11] clause 9.3.1.8.

globalENbId

GlobalRanNodeId

O

0..1

It indicates the global identity of the eNodeB in which the UE is currently located.

See 3GPP TS 36.413 [16] clause 9.2.1.37.

NOTE: Either the "globalNgenbId" attribute or the "globalENbId" attribute shall be included in the "EutraLocation" data type.

tai

Tai

M

1

Tracking Area Identity

ncgi

Ncgi

M

1

NR Cell Identity

ignoreNcgi

boolean

O

0..1

This flag when present shall indicate that the Ncgi shall be ignored.

When present, it shall be set as follows:

– true: ncgi shall be ignored.

– false (default): ncgi shall not be ignored.

ageOfLocationInformation

integer

O

0 1

The value represents the elapsed time in minutes since the last network contact of the mobile station.

Value "0" indicates that the location information was obtained after a successful paging procedure for Active Location Retrieval when the UE is in idle mode or after a successful NG-RAN location reporting procedure with the gNB when the UE is in connected mode.

Any other value than "0" indicates that the location information is the last known one.

See 3GPP TS 29.002 [21] clause 17.7.8.

ueLocationTimestamp

DateTime

O

0..1

The value represents the UTC time when the UeLocation information was acquired.

geographicalInformation

string

O

0..1

Refer to geographical Information.

See 3GPP TS 23.032 [23] clause 7.3.2. Only the description of an ellipsoid point with uncertainty circle is allowed to be used.

Allowed characters are 0-9 and A-F;

geodeticInformation

string

O

0..1

Refers to Calling Geodetic Location.

See ITU-T Recommendation Q.763 (1999) [24] clause 3.88.2. Only the description of an ellipsoid point with uncertainty circle is allowed to be used.

Allowed characters are 0-9 and A-F.

globalGnbId

GlobalRanNodeId

O

0..1

It indicates the global identity of the gNodeB in which the UE is currently located.

See 3GPP TS 38.413 [11] clause 9.3.1.6.

n3gppTai

Tai

C

0..1

This IE shall be present over the 3GPP PLMN internal interfaces, but it shall not be present over the N5 interface. When present, it shall contain the TAI reported by the N3IWF, TNGF or W-AGF for the non-3GPP access.

n3IwfId

string

C

0..1

This IE shall contain the N3IWF identifier received over NGAP and shall be encoded as a string of hexadecimal characters. Each character in the string shall take a value of "0" to "9", "a" to "f" or "A" to "F" and shall represent 4 bits. The most significant character representing the 4 most significant bits of the N3IWF ID shall appear first in the string, and the character representing the 4 least significant bit of the N3IWF ID shall appear last in the string.

Pattern: ‘^[A-Fa-f0-9]+$’

Example:

The N3IWF Id 0x5BD6 shall be encoded as "5BD6".

It shall be present over the 3GPP PLMN internal interfaces if the UE is accessing the 5GC via an untrusted non-3GPP access, but shall not be present over the N5 interface.

ueIpv4Addr

Ipv4Addr

C

0..1

UE/N5CW device local IPv4 address (used to reach the N3IWF, TNGF or TWIF).

The ueIPv4Addr or the ueIPv6Addr shall be present if the UE is accessing the 5GC via a trusted or untrusted non-3GPP access and the information is available.

ueIpv6Addr

Ipv6Addr

C

0..1

UE/N5CW device local IPv6 address (used to reach the N3IWF, TNGF or TWIF).

The ueIPv4Addr or the ueIPv6Addr shall be present if the UE is accessing the 5GC via a trusted or untrusted non-3GPP access and the information is available.

portNumber

Uinteger

C

0..1

UDP or TCP source port number. It shall be present if the UE is accessing the 5GC via a trusted or untrusted non-3GPP access and NAT is detected.

protocol

TransportProtocol

O

0..1

This IE may be present if portNumber is present.

When present, this IE shall indicate the transport protocol used by the UE to access the core network via a trusted or untrusted non-3GPP access and NAT is detected.

The absence of this IE indicates that the transport protocol used by the UE to access the core network via a trusted or untrusted non-3GPP access is not specified, i.e. could be UDP or TCP.

tnapId

TnapId

C

0..1

This IE shall contain the TNAP Identifier, see clause 5.6.2 of 3GPP TS 23.501 [8].

twapId

TwapId

C

0..1

In the scenario of accessing 5GC from N5CW device, this IE shall contain the TWAP Identifier, see clause 4.2.8.5.3 of 3GPP TS 23.501 [8].

In the scenario of interworking between ePDG/EPC and 5GS, this IE shall contain the WLAN location information, see clause 4.5.7.2.8 of 3GPP TS 23.402 [48].

hfcNodeId

HfcNodeId

C

0..1

This IE shall contain the HFC Node Identifier received over NGAP. It shall be present for a 5G-CRG/FN-CRG accessing the 5GC via wireline access network.

gli

Gli

C

0..1

This IE shall contain the Global Line Identifier. It shall be present for a 5G-BRG/FN-BRG accessing the 5GC via wireline access network.

w5gbanLineType

LineType

O

0..1

This IE may be present for a 5G-BRG/FN-BRG accessing the 5GC via wireline access network.

When present, it shall indicate the type of the wireline (DSL or PON).

gci

Gci

C

0..1

This IE shall contain the Global Cable Identifier. It shall be present for the N5GC device accessing the 5GC via wireline access network. See clause 4.10a of 3GPP TS 23.316 [30]

upIntegr

UpIntegrity

M

1

This IE shall indicate whether UP integrity protection is required, preferred or not needed for all the traffic on the PDU Session.

upConfid

UpConfidentiality

M

1

This IE shall indicate whether UP confidentiality protection is required, preferred or not needed for all the traffic on the PDU Session.

group

Uinteger

M

1

This IE shall indicate the group of the NGAP cause. The value of this IE shall equal to the ASN.1 value of the specified NGAP cause group.

NGAP supports following cause groups defined as separate enumerations, as specified in clause 9.4.5 of 3GPP TS 38.413 [11], with following values:

0 – radioNetwork

1 – transport

2 – nas

3 – protocol

4 – misc

value

Uinteger

M

1

This IE shall carry the NG AP cause value in specific cause group identified by the "group" attribute, as specified in clause 9.4.5 of 3GPP TS 38.413 [11].

backupAmf

AmfName

M

1

This IE shall contain the AMF name of the backup AMF that can serve the specific GUAMI(s) supported by the primary AMF (see clause 5.21.2.3 of 3GPP TS 23.501 [8]).

guamiList

array(Guami)

C

1..N

If present, this IE shall contain the list of GUAMI(s) (supported by the primary AMF) which the backup AMF can serve.

If this IE is absent, it indicates that the backup AMF can serve all the GUAMI(s) supported by the primary AMF.

contentId

string

M

1

This IE shall contain the value of the Content-ID header of the referenced binary body part.

dnai

Dnai

M

1

Identifies the location of the application.

routeInfo

RouteInformation

C

0..1

Includes the traffic routing information.

routeProfId

string

C

0..1

Identifies the routing profile Id.

NOTE: At least one of the "routeInfo" attribute and the "routeProfId" attribute shall be included in the "RouteToLocation" data type..

ipv4Addr

Ipv4Addr

C

0..1

Ipv4address of the tunnel end point in the data network.

ipv6Addr

Ipv6Addr

C

0..1

Ipv6 address of the tunnel end point in the data network.

portNumber

Uinteger

M

1

UDP port number of the tunnel end point in the data network.

NOTE: At least one of the "ipv4Addr" attribute and the "ipv6Addr" attribute shall be included in the "RouteInformation" data type.

tacs

array(Tac)

C

1..N

List of TACs; shall be present if and only if areaCode is absent.

areaCode

AreaCode

C

0..1

Area Code; shall be present if and only if tacs is absent.

restrictionType

RestrictionType

C

0..1

string
"ALLOWED_AREAS" or
"NOT_ALLOWED_AREAS"

shall be present if and only if the areas attribute is present

areas

array(Area)

O

0..N

(NOTE)

A list of Areas.
These areas are:

– allowed areas if RestrictionType is "ALLOWED_AREAS"

– not allowed areas if RestrictionType is "NOT_ALLOWED_AREAS"

maxNumOfTAs

Uinteger

C

0..1

Maximum number of allowed tracking areas for use when restrictionType indicates "ALLOWED_AREAS".

This attribute shall be absent when attribute "restrictionType" takes the value "NOT_ALLOWED_AREAS".

maxNumOfTAsForNotAllowedAreas

Uinteger

C

0..1

Maximum number of allowed tracking areas for use when restrictionType indicates "NOT_ALLOWED_AREAS".

This attribute shall be absent when attribute "restrictionType" takes the value "ALLOWED_AREAS".

NOTE: The empty array is used when service is allowed/restricted nowhere.

praId

string

C

0..1

Represents an identifier of the Presence Reporting Area (see clause 28.10 of 3GPP TS 23.003 [7]). This IE shall be present if the Area of Interest subscribed or reported is a Presence Reporting Area or a Set of Core Network predefined Presence Reporting Areas.

When present, it shall be encoded as a string representing an integer in the following ranges:

0 to 8 388 607 for UE-dedicated PRA

8 388 608 to 16 777 215 for Core Network predefined PRA.

Examples:

PRA ID 123 is encoded as "123"

PRA ID 11 238 660 is encoded as "11238660"

additionalPraId

string

C

0..1

This IE may be present if the praId IE is present and if it contains a PRA identifier referring to a set of Core Network predefined Presence Reporting Areas.

When present, this IE shall contain a PRA Identifier of an individual PRA within the Set of Core Network predefined Presence Reporting Areas indicated by the praId IE.

presenceState

PresenceState

C

0..1

Indicates whether the UE is inside or outside of the area of interest (e.g presence reporting area or the LADN area), or if the presence reporting area is inactive in the serving node. (NOTE)

trackingAreaList

array(Tai)

C

1..N

Represents the list of tracking areas that constitutes the area. This IE shall be present if the subscription or the event report is for tracking UE presence in the tracking areas. For non 3GPP access the TAI shall be the N3GPP TAI.

ecgiList

array(Ecgi)

C

1..N

Represents the list of EUTRAN cell Ids that constitutes the area. This IE shall be present if the Area of Interest subscribed is a list of EUTRAN cell Ids.

ncgiList

array(Ncgi)

C

1..N

Represents the list of NR cell Ids that constitutes the area. This IE shall be present if the Area of Interest subscribed is a list of NR cell Ids.

globalRanNodeIdList

array(GlobalRanNodeId)

C

1..N

Represents the list of NG RAN node identifiers that constitutes the area. This IE shall be present if the Area of Interest subscribed is a list of NG RAN node identifiers.

globalENbIdList

array(GlobalRanNodeId)

C

1..N

Represents the list of eNodeB identifiers that constitutes the area. This IE shall be present if the Area of Interest subscribed is a list of eNodeB identifiers.

NOTE: If the additionalPraId IE is present, this IE shall state the presence information of the UE for the individual PRA identified by the additionalPraId IE; If the additionalPraId IE is not present, this IE shall state the presence information of the UE for the PRA identified by the praId IE.

plmnId

PlmnId

M

1

Indicates the identity of the PLMN that the RAN node belongs to.

n3IwfId

N3IwfId

C

0..1

This IE shall be included if the AN node represents a N3IWF. When present, this IE shall contain the identifier of the N3IWF.

(NOTE 1).

gNbId

GNbId

C

0..1

This IE shall be included if the RAN Node Id represents a gNB. When present, this IE shall contain the identifier of the gNB. (NOTE 1).

ngeNbId

NgeNbId

C

0..1

This IE shall be included if the RAN Node Id represents a NG-eNB. When present, this IE shall contain the identifier of an NG-eNB.

(NOTE 1).

wagfId

WAgfId

C

0..1

This IE shall be included if the AN node represents a W-AGF. When present, this IE shall contain the identifier of the W-AGF.

(NOTE 1).

tngfId

TngfId

C

0..1

This IE shall be included if the AN node represents a TNGF. When present, this IE shall contain the identifier of the TNGF.

(NOTE 1).

nid

Nid

O

0..1

Network Identifier shall be present in case of SNPN, PlmnId together with Nid indicates the identity of the SNPN to which the RanNode belongs to.

eNbId

ENbId

C

0..1

This IE shall be included if the RAN Node Id represents an eNB. When present, this IE shall contain the identifier of an eNB.

(NOTE 1, NOTE 2).

NOTE 1: One of the six attributes n3IwfId, gNbIdm, ngeNbId, wagfId, tngfId, eNbId shall be present.

NOTE 2: For UEs with 5GS subscription but without 5G NAS support, eNbId is used on N7 instead of n3IwfId, gNbIdm, ngeNbId.

bitLength

integer

M

1

Unsigned integer representing the bit length of the gNB ID as defined in clause 9.3.1.6 of 3GPP TS 38.413 [11], within the range 22 to 32

gNBValue

string

M

1

This represents the identifier of the gNB.

The string shall be formatted with following pattern:

‘^[A-Fa-f0-9]{6,8}$’

The value of the gNB ID shall be encoded in hexadecimal representation. Each character in the string shall take a value of "0" to "9", "a" to "f" or "A" to "F" and shall represent 4 bits. The padding 0 shall be added to make multiple nibbles, the most significant character representing the padding 0 if required together with the 4 most significant bits of the gNB ID shall appear first in the string, and the character representing the 4 least significant bit of the gNB ID shall appear last in the string.

Examples:

A 30 bit value "382A3F47" indicates a gNB ID with value 0x382A3F47

A 22 bit value "2A3F47" indicates a gNB ID with value 0x2A3F47

atsssLL

boolean

C

0..1

Indicates the ATSSS-LL capability to support procedures related to Access Traffic Steering, Switching, Splitting (see clauses 4.2.10, 5.32 of 3GPP TS 23.501 [8]).

true: Supported
false (default): Not Supported

mptcp

boolean

C

0..1

Indicates the MPTCP capability to support procedures related to Access Traffic Steering, Switching, Splitting (see clauses 4.2.10, 5.32 of 3GPP TS 23.501 [8]).

true: Supported
false (default): Not Supported

rttWithoutPmf

boolean

C

0..1

This IE is only used by the UPF to indicate whether the UPF supports RTT measurement without PMF (see clauses 5.32.2, 6.3.3.3 of 3GPP TS 23.501 [8]).

If this attribute is present and set to true, the mptcp attribute shall also be present and set to true.

true: Supported

false (default): Not Supported.

mcc

Mcc

M

1

Mobile Country Code

mnc

Mnc

M

1

Mobile Network Code

nid

Nid

C

0..1

Network Identity; Shall be present if PlmnIdNid identifies an SNPN (see clauses 5.30.2.3, 5.30.2.9, 6.3.4, and 6.3.8 in 3GPP TS 23.501 [2]). Otherwise, this attribute shall be absent.

remainPacketsUl

integer

C

0..1

This IE shall be included if available.

When present, it shall contain the number of packets the UE is allowed to send uplink in the given time unit for the given PDU session (see clause 5.31.14.3 of 3GPP TS 23.501 [8]).

remainPacketsDl

integer

C

0..1

This IE shall be included if available.

When present it shall contain the number of packets the AF is allowed to send downlink in the given time unit for the given PDU session (see clause 5.31.14.3 of 3GPP TS 23.501 [8]).

validityTime

DateTime

C

0..1

This IE shall be included if available.

When present, it shall indicate the period of time during which the small data rate control status will remain valid (see clause 5.31.14.3 of 3GPP TS 23.501 [8]).

remainExReportsUl

integer

C

0..1

This IE shall be included if available.

When present, it shall indicate number of additional exception reports the UE is allowed to send uplink in the given time unit for the given PDU session (see clause 5.31.14.3 of 3GPP TS 23.501 [8]).

remainExReportsDl

integer

C

0..1

This IE shall be included if available.

When present, it shall indicate number of additional exception reports the AF is allowed to send downlink in the given time unit for the given PDU session (see clause 5.31.14.3 in 3GPP TS 23.501 [8]).

hfcNId

HfcNId

M

1

HFC Node Id.

globalLineIds

array(Gli)

C

1..N

List of Global Line Identifiers, for a 5G-BRG accessing the 5GC via wireline access network.

hfcNIds

array(HfcNId)

C

1..N

List of HFC Node Ids, for a 5G-CRG/FN-CRG is accessing the 5GC via wireline access network.

areaCodeB

AreaCode

C

0..1

Area Code for for 5G-BRG accessing via wireline access network

areaCodeC

AreaCode

C

0..1

Area Code for 5G-CRG/FN-CRG is accessing via wireline access network

NOTE: One and only one of the "globLineIds", "hfcNIds", "areaCodeB" and "areaCodeC" attributes shall be included in a WirelineArea data structure.

restrictionType

RestrictionType

C

0..1

string
"ALLOWED_AREAS" or
"NOT_ALLOWED_AREAS"

(NOTE 1)

areas

array(WirelineArea)

C

0..N

A list of Areas.
These areas are:

– allowed areas if RestrictionType is "ALLOWED_AREAS"

– not allowed areas if RestrictionType is "NOT_ALLOWED_AREAS"

(NOTE 1) (NOTE 2)

NOTE 1: The "restrictionType" attribute and the "areas" attribute shall be either both present or absent.

NOTE 2: The empty array is used when service is allowed/restricted nowhere.

remainPacketsUl

integer

C

0..1

This IE shall be included if available.

When present, it shall contain the number of packets the UE is allowed to send uplink in the given time unit for the given APN (all PDN connections of the UE to this APN see clause 4.7.7.3 in 3GPP TS 23.401 [33]).

remainPacketsDl

integer

C

0..1

This IE shall be included if available.

When present, it shall contain the number of packets, which the UE is allowed to send downlink for the given time unit period of time and for the given APN (all PDN connections of the UE to this APN, see clause 4.7.7.3 in 3GPP TS 23.401 [33]).

validityTime

DateTime

C

0..1

This IE shall be included if available.

When present, it shall indicate the period of time during which the APN rate control status will remain valid.

remainExReportsUl

integer

C

0..1

This IE shall be included if available.

When present, it shall indicate the number of additional exception reports the UE is allowed to send uplink in the given time unit for the given APN (all PDN connections of the UE to this APN, see clause 4.7.7.3 in 3GPP TS 23.401 [33]).

remainExReportsDl

integer

C

0..1

This IE shall be included if available.

When present, it shall indicate the number of additional exception reports the AF is allowed to send downlink in the given time unit for the given APN (all PDN connections of the UE to this APN, see clause 4.7.7.3 in 3GPP TS 23.401 [33]).

daysOfWeek

array(DayOfWeek)

O

1..6

Identifies the day(s) of the week. If absent, it indicates every day of the week.

timeOfDayStart

TimeOfDay

O

0..1

Identifies the start time of the day.

timeOfDayEnd

TimeOfDay

O

0..1

Identifies the end time of the day.

batteryInd

boolean

O

0..1

When present, this IE shall indicate whether the UE is battery powered or not.

true: the UE is battery powered;

false or absent: the UE is not battery powered.

replaceableInd

boolean

O

0..1

When present, this IE shall indicate whether the battery of the UE is replaceable or not.

true: the battery of the UE is replaceable;

false or absent: the battery of the UE is not replaceable.

rechargeableInd

boolean

O

0..1

When present, this IE shall indicate whether the battery of the UE is rechargeable or not.

true: the battery of UE is rechargeable;

false or absent: the battery of the UE is not rechargeable.

NOTE: Parameters "replaceableInd" and "rechargeableInd" are only included if the value of Parameter "batteryInd" is true.

acsUrl

Uri

O

0..1

This IE may contain the URL of the ACS, see BBF TR-069 [34] or BBF TR-369 [35].

(NOTE)

acsIpv4Addr

Ipv4Addr

O

0..1

This IE may contain the IPv4 address of the ACS, see BBF TR-069 [34] or BBF TR-369 [35].

(NOTE)

acsIpv6Addr

Ipv6Addr

O

0..1

This IE may contain the IPv6 address of the ACS, see BBF TR-069 [34] or BBF TR-369 [35].

(NOTE)

NOTE: At least one of acsUrl, acsIpv4Addr, acsIpv6Addr shall be included.

vehicleUeAuth

UeAuth

C

0..1

This IE shall be present if available. When present, it shall indicate whether the UE is authorized as Vehicle UE.

pedestrianUeAuth

UeAuth

C

0..1

This IE shall be present if available. When present, it shall indicate whether the UE is authorized as Pedestrian UE.

vehicleUeAuth

UeAuth

C

0..1

This IE shall be present if available. When present, it shall indicate whether the UE is authorized as Vehicle UE.

pedestrianUeAuth

UeAuth

C

0..1

This IE shall be present if available. When present, it shall indicate whether the UE is authorized as Pedestrian UE.

pc5QosFlowList

array(Pc5QosFlowItem)

M

1..N

This IE shall contain the set of PC5 flow(s).

pc5LinkAmbr

BitRate

C

0..1

This IE shall be present if available. When present, it shall represent the PC5 Link Aggregated Bit Rates for all the Non-GBR QoS Flows (see clause 5.4.2.3 of 3GPP TS 23.287 [36]).

pqi

5Qi

M

1

PQI is a special 5QI (see clause 5.4.2.1 of 3GPP TS 23.287 [36]).

pc5FlowBitRates

Pc5FlowBitRates

C

0..1

This IE shall be present if available. When present, it shall represent the PC5 Flow Bit Rates (see clause 5.4.2.2 of 3GPP TS 23.287 [36]).

range

Uinteger

C

0..1

This IE shall be present if available. When present, it shall represent the Range in the unit of meters (see clause 5.4.2.4 of 3GPP TS 23.287 [36]).

guaFbr

BitRate

C

0..1

This IE shall be present if available. When present, it shall contain the guaranteed Bit Rate for the PC5 QoS flow.

maxFbr

BitRate

C

0..1

This IE shall be present if available. When present, it shall contain the maximum Bit Rate for the PC5 QoS flow.

cgi

CellGlobalId

O

0..1

Cell Global Identification. See 3GPP TS 23.003 [7], clause 4.3.1

(NOTE 1)

sai

ServiceAreaId

O

0..1

Service Area Identifier. See 3GPP TS 23.003 [7], clause 12.5

(NOTE 1)

lai

LocationAreaId

O

0..1

Location area identification. See 3GPP TS 23.003 [7], clause 4.1

(NOTE 1)

rai

RoutingAreaId

O

0..1

Routing Area Identification. See 3GPP TS 23.003 [7], clause 4.2

ageOfLocationInformation

integer

O

0 1

The value represents the elapsed time in minutes since the last network contact of the mobile station.

Value "0" indicates that the location information was obtained after a successful paging procedure for Active Location Retrieval when the UE is in idle mode or after a successful location reporting procedure the UE is in connected mode.

Any other value than "0" indicates that the location information is the last known one.

See 3GPP TS 29.002 [21] clause 17.7.8.

ueLocationTimestamp

DateTime

O

0..1

The value represents the UTC time when the UeLocation information was acquired.

geographicalInformation

string

O

0..1

Refer to geographical Information.

See 3GPP TS 23.032 [23] clause 7.3.2. Only the description of an ellipsoid point with uncertainty circle is allowed to be used.

Allowed characters are 0-9 and A-F;

geodeticInformation

string

O

0..1

Refers to Calling Geodetic Location.

See ITU-T Recommendation Q.763 (1999) [24] clause 3.88.2. Only the description of an ellipsoid point with uncertainty circle is allowed to be used.

Allowed characters are 0-9 and A-F.

NOTE 1: Exactly one of cgi, sai or lai shall be present.

locationNumber

string

O

0..1

Location number within the PLMN. See 3GPP TS 23.003 [7], clause 4.5.

cgi

CellGlobalId

O

0..1

Cell Global Identification. See 3GPP TS 23.003 [7], clause 4.3.1

(NOTE 1)

rai

RoutingAreaId

O

0..1

Routing Area Identification. See 3GPP TS 23.003 [7], clause 4.2

(NOTE 1)

sai

ServiceAreaId

O

0..1

Service Area Identifier. See 3GPP TS 23.003 [7], clause 12.5

(NOTE 1)

lai

LocationAreaId

O

0..1

Location Area identification. See 3GPP TS 23.003 [7], clause 4.1

(NOTE 1)

vlrNumber

string

O

0..1

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

mscNumber

string

O

0..1

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

ageOfLocationInformation

integer

O

0 1

The value represents the elapsed time in minutes since the last network contact of the mobile station.

Value "0" indicates that the location information was obtained after a successful paging procedure for Active Location Retrieval when the UE is in idle mode or after a successful location reporting procedure the UE is in connected mode.

Any other value than "0" indicates that the location information is the last known one.

See 3GPP TS 29.002 [21] clause 17.7.8.

ueLocationTimestamp

DateTime

O

0..1

The value represents the UTC time when the UeLocation information was acquired.

geographicalInformation

string

O

0..1

Refer to geographical Information.

See 3GPP TS 23.032 [23] clause 7.3.2. Only the description of an ellipsoid point with uncertainty circle is allowed to be used.

Allowed characters are 0-9 and A-F;

geodeticInformation

string

O

0..1

Refers to Calling Geodetic Location.

See ITU-T Recommendation Q.763 (1999) [24] clause 3.88.2. Only the description of an ellipsoid point with uncertainty circle is allowed to be used.

Allowed characters are 0-9 and A-F.

NOTE 1: Exactly one of cgi, rai, sai or lai shall be present.

plmnId

PlmnId

M

1

PLMN Identity

lac

string

M

1

Location Area Code

Pattern: ‘^[A-Fa-f0-9]{4}$’

cellId

string

M

1

Cell Identity

Pattern: ‘^[A-Fa-f0-9]{4}$’

plmnId

PlmnId

M

1

PLMN Identity

lac

string

M

1

Location Area Code

Pattern: ‘^[A-Fa-f0-9]{4}$’

sac

string

M

1

Service Area Code

Pattern: ‘^[A-Fa-f0-9]{4}$’

plmnId

PlmnId

M

1

PLMN Identity

lac

string

M

1

Location Area Code

Pattern: ‘^[A-Fa-f0-9]{4}$’

plmnId

PlmnId

M

1

PLMN Identity

lac

string

M

1

Location Area Code

Pattern: ‘^[A-Fa-f0-9]{4}$’

rac

string

M

1

Routing Area Code

Pattern: ‘^[A-Fa-f0-9]{2}$’

ipv4Addr

Ipv4Addr

C

0..1

Ipv4 address of the source of downlink data.

ipv6Addr

Ipv6Addr

C

0..1

Ipv6 address of the source of downlink data.

portNumber

Uinteger

O

0..1

Port number of the source of downlink data.

macAddr

MacAddr48

C

0..1

Source MAC address.

NOTE: Either IP address (at least one of the "ipv4Addr" attribute or the "ipv6Addr" attribute) or MAC address (the "macAddr" attribute) shall be included.

counter

integer

M

1

Unsigned integer identifying the MO Exception Data Counter, as specified in clause 5.31.14.3 of 3GPP TS 23.501 [8].

timeStamp

DateTime

O

0..1

UTC time indicating the time at which the counter value increased from 0 to 1.

snssai

Snssai

M

1

Subscribed S-NSSAI

status

AuthStatus

M

1

This flag when present shall indicate the NSSAA status of the related Snssai.

ssId

string

C

0..1

This IE shall be present if the UE is accessing the 5GC via a trusted WLAN access network.

When present, it shall contain the SSID of the access point to which the UE is attached, that is received over NGAP, see IEEE Std 802.11-2012 [31].

bssId

string

C

0..1

This IE shall be present if available.

When present, it shall contain the BSSID of the access point to which the UE is attached, that is received over NGAP, see IEEE Std 802.11-2012 [31].

civicAddress

Bytes

C

0..1

This IE shall be present if available.

When present, it shall contain the civic address information of the TNAP to which the UE is attached, including the Location-Information Attribute and / or Location-Data Attribute as defined in IETF RFC 5580 [40].

ssId

string

M

1

This IE shall contain the SSID of the access point to which the UE is attached, that is received over NGAP, see IEEE Std 802.11-2012 [31].

bssId

string

C

0..1

This IE shall be present if available.

When present, it shall contain the BSSID of the access point to which the UE is attached, for trusted WLAN access, see IEEE Std 802.11-2012 [31].

civicAddress

Bytes

C

0..1

This IE shall be present if available.

When present, it shall contain the civic address information of the TWAP to which the UE is attached, for trusted WLAN access. This IE shall include the Location-Information Attribute and / or Location-Data Attribute as defined in IETF RFC 5580 [40].

sdRanges

array(SdRange)

C

1..N

When present, it shall contain the range(s) of Slice Differentiator values supported for the Slice/Service Type value indicated in the sst attribute of the Snssai data type (see clause 5.4.4.2).

wildcardSd

boolean

C

0..1

When present, it shall be set to true, to indicate that all SD values are supported for the Slice/Service Type value indicated in the sst attribute of the Snssai data type (see clause 5.4.4.2).

NOTE: sdRanges and wildcardSd shall not be present simultaneously.

start

string

M

1

First value identifying the start of an SD range.

This string shall be formatted as specified for the sd attribute of the Snssai data type in clause 5.4.4.2.

end

string

M

1

Last value identifying the end of an SD range.

This string shall be formatted as specified for the sd attribute of the Snssai data type in clause 5.4.4.2.

proseDirectDiscoveryAuth

UeAuth

C

0..1

This IE shall be present if available. When present, it shall indicate whether the UE is authorized to use ProSe Direct Discovery.

proseDirectCommunicationAuth

UeAuth

C

0..1

This IE shall be present if available. When present, it shall indicate whether the UE is authorized to use ProSe Direct Communication.

ecsFqdnList

array(Fqdn)

C

1..N

This IE shall be included if available.

When present, it shall contain the list of FQDN(s) of Edge Configuration Server(s).

ecsIpAddressList

array(IpAddr)

C

1..N

This IE shall be included if available.

When present, it shall contain the list of IP Address (es) of Edge Configuration Server(s).

ecsUriList

array(Uri)

C

1..N

This IE shall be included if available.

When present, it shall contain the list of URI(s) of the Edge Configuration Server(s).

ecsProviderId

string

C

0..1

This IE shall be included if available.

When present, it shall contain the identifier of the Edge Configuration Server Provider.

ipv4Addr

Ipv4Addr

C

0..1

When present, it shall contain the IPv4 address.

ipv6Addr

Ipv6Addr

C

0..1

When present, it shall contain the IPv6 address.

ipv6Prefix

Ipv6Prefix

C

0..1

When present, it shall contain the IPv6 Prefix.

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

numericValNumUes

Integer

C

0..1

This attribute may be present in the following cases:

– to configure the monitoring threshold for the reporting of the number of registered UEs for a network slice identified by an S-NSSAI;

– to report the network slice status for the current number of registered UEs.

When used to configure the monitoring threshold for an S-NSSAI, it shall contain the configured event monitoring threshold value for monitoring the number of registered UEs expressed in a numerical value.

When used to report the network slice status for an S-NSSAI, it shall contain the current number of registered UEs in the concerned network slice expressed in a numerical value.

For threshold based reporting and the threshold value for the number of registered UEs in the concerned network slice was previously configured in the form of a numerical value, this attribute shall contain the current number of registered UEs in the concerned network slice expressed in a numerical value.

numericValNumPduSess

Integer

C

0..1

This attribute may be present in the following cases:

– to configure the monitoring threshold for the reporting of the number established PDU session for a network slice identified by an S-NSSAI;

– to report the network slide status for the number of established PDU sessions.

When used to configure the monitoring threshold for an S-NSSAI, it shall contain the configured event monitoring threshold value for monitoring the number of established PDU sessions expressed in a numerical value.

When used to report the network slice status for an S-NSSAI, it shall contain the current number of established PDU sessions in the concerned network slice expressed in a numerical value.

For threshold based reporting and the threshold value for the number of established PDU sessions in the concerned network slice was previously configured in the form of a numerical value,, this attribute shall contain the current number of established PDU sessions in the concerned network slice expressed in a numerical value.

percValueNumUes

Integer

C

0..1

This attribute may be present in the following cases:

– to configure the monitoring threshold for the reporting of the number of registered UEs for a network slice identified by an S-NSSAI;

– to report the network slice status for the number of registered UEs .

When used to configure the monitoring threshold for an S-NSSAI, it shall contain an unsigned integer indicating the event monitoring threshold value for the number of registered UEs expressed in percentage format.

When used to report the network slice status for an S-NSSAI, it shall contain the current number of registered UEs in the concerned network slice expressed as a percentage. For threshold based reporting and the threshold value for the number of registered UEs in the concerned network slice was previously configured as a percentage, this attribute shall contain the current number of registered UEs in the concerned network slice expressed as a percentage.

Minimum = 0. Maximum = 100.

percValueNumPduSess

Integer

C

0..1

This IE may be present in the following cases:

– to configure the monitoring threshold for the reporting of the number of established PDU sessions for a network slice identified by an S-NSSAI;

– to report the network slice status for the number of established PDU sessions.

When used to configure the monitoring threshold for an S-NSSAI, it shall contain an unsigned integer indicating the event monitoring threshold value for the number of established PDU sessions expressed in percentage format.

When used to report the status of an S-NSSAI, it shall contain the current number of established PDU sessions in the concerned network slice expressed as a percentage.

For threshold based reporting and the threshold value for the number of established PDU sessions in the concerned network slice was previously configured as a percentage, this attribute shall contain the current number of established PDU sessions in the concerned network slice expressed as a percentage.

Minimum = 0. Maximum = 100.

reachedNumUes

SACInfo

O

0..1

Contains a confirmation that the requested threshold for the number of registered UEs in the concerned network slice was reached, when threshold based reporting is used, or the current number of registered UEs in the concerned network slice, when periodic reporting / immediate reporting is used.

reachedNumPduSess

SACInfo

O

0..1

Contains a confirmation that the requested threshold for the number of established PDU session in the concerned network slice was reached, when threshold based reporting is used, or the current number of established PDU sessions in the concerned network slice, when periodic reporting / immediate reporting is used.

trackingAreaList

array(Tai)

C

1..N

This IE shall be included if available.

When present, it shall contain the list of tracking areas identities.

countries

array(Mcc)

O

1..N

When present, it shall contain the list of Mobile Country Codes.

geographicalServiceArea

GeoServiceArea

O

0..1

Geographical Service Area; see 3GPP TS 23.558 [49] clause 7.3.3.3

ipv4Addresses

array(Ipv4Addr)

C

1..N

IPv4 address(es) of the server (NOTE).

ipv6Addresses

array(Ipv6Addr)

C

1..N

IPv6 address(es) of the server (NOTE).

fqdnList

array(Fqdn)

C

1..N

List of FQDNs (Fully Qualified Domain Names) of the server (NOTE).

NOTE: At least one of the addressing parameters (ipv4addresses, ipv6adresses or fqdnList) shall be included in the ServerAddressingInfo; all addressing parameters in this data type shall be understood as referring to a same sever.

callbackUri

Uri

M

1

This IE shall contain the Callback URI on the PCF for a UE to receive the SM Policy Association Establishment and Termination Event Notifications from the PCF for a PDU session.

bindingInfo

string

O

0..1

This IE shall be present, if available.

When present, this IE shall contain the Binding indications of the Callback URI on the PCF for a UE indicated by callbackUri IE and set to the value of the 3gpp-Sbi-Binding header defined in clause 5.2.3.2.6 of 3GPP TS 29.500 [25], without the header name.

snssai

Snssai

M

1

This IE shall indicate the S-NSSAI in the serving PLMN of a PDU session.

dnn

Dnn

M

1

This IE shall Indicate the DNN of a PDU session.

If DNN replacement if applicable for the PDU session, this IE shall indicate the DNN of the PDU session after DNN replacement.

source

EasServerAddress

M

1

Address of the source EAS, i.e., address that shall be used for the traffic on the N3 side of the UPF(s).

target

EasServerAddress

M

1

Address of the target EAS, i.e., address that shall be used for the traffic on the N6 side of the UPF(s).

ip

IpAddr

M

1

IP address information.

port

Uinteger

M

1

IP port number.

accessAllowed

boolean

C

0..1

Indicates if access is allowed to a given serving network, e.g. a PLMN (MCC, MNC) or an SNPN (MCC, MNC, NID). NOTE

NOTE: The actual query determines if the ‘accessAllowed’ attribute refers to an SNPN or to a PLMN.

geographicAreaList

array(GeographicArea)

O

1..N

Identifies a list of geographic area specified by different shapes.

civicAddressList

array(CivicAddress)

O

1..N

Identifies a list of civic address.

Snssai

1

Common data type defined in clause 5.4.4.2.

SnssaiExtension

1

Extensions to the Snssai common data type defined in clause 5.4.4.66.

NOTE: The sdRanges and wildcardSd attributes shall be exclusive from each other. If one of these attributes is present, the sd attribute shall also be present and it shall contain one Slice Differentiator value within the range of SD (if the sdRanges attribute is present) or with any value (if the wildcardSd attribute is present).