5.5 Data Types related to 5G QoS

29.5713GPP5G SystemCommon Data Types for Service Based InterfacesRelease 18Stage 3TS

5.5.1 Introduction

This clause defines common data types related to 5G QoS.

5.5.2 Simple Data Types

This clause specifies common simple data types.

Table 5.5.2-1: Simple Data Types

Type Name

Type Definition

Description

Qfi

integer

Unsigned integer identifying a QoS flow, within the range 0 to 63.

QfiRm

integer

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

5Qi

integer

Unsigned integer representing a 5G QoS Identifier (see clause 5.7.2.1 of 3GPP TS 23.501 [8]), within the range 0 to 255.

5QiRm

integer

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

BitRate

string

String representing a bit rate that shall be formatted as follows:

Pattern: ‘^\d+(\.\d+)? (bps|Kbps|Mbps|Gbps|Tbps)$’

(NOTE)

Examples:

"125 Mbps", "0.125 Gbps", "125000 Kbps"

BitRateRm

string

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

ArpPriorityLevel

integer

Unsigned integer indicating the ARP Priority Level (see clause 5.7.2.2 of 3GPP TS 23.501 [8]), within the range 1 to 15.

Values are ordered in decreasing order of priority, i.e. with 1 as the highest priority and 15 as the lowest priority.

ArpPriorityLevelRm

integer

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

5QiPriorityLevel

integer

Unsigned integer indicating the 5QI Priority Level (see clauses 5.7.3.3 and 5.7.4 of 3GPP TS 23.501 [8]), within the range 1 to 127.

Values are ordered in decreasing order of priority, i.e. with 1 as the highest priority and 127 as the lowest priority.

5QiPriorityLevelRm

integer

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

PacketDelBudget

Integer

Unsigned integer indicating Packet Delay Budget (see clauses 5.7.3.4 and 5.7.4 of 3GPP TS 23.501 [8])), expressed in milliseconds.

Minimum = 1.

PacketDelBudgetRm

integer

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

PacketErrRate

string

String representing Packet Error Rate (see clause 5.7.3.5 and 5.7.4 of 3GPP TS 23.501 [8]), expressed as a "scalar x 10-k" where the scalar and the exponent k are each encoded as one decimal digit.

Pattern: ‘^([0-9]E-[0-9])$’

Examples:

Packer Error Rate 4×10-6 shall be encoded as "4E-6".

Packer Error Rate 10-2 shall be encoded as "1E-2".

PacketErrRateRm

string

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

PacketLossRate

Integer

Unsigned integer indicating Packet Loss Rate (see clauses 5.7.2.8 and 5.7.4 of 3GPP TS 23.501 [8]), expressed in tenth of percent.

Minimum = 0. Maximum = 1000.

PacketLossRateRm

Integer

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

AverWindow

Integer

Unsigned integer indicating Averaging Window (see clause 5.7.3.6 and 5.7.4 of 3GPP TS 23.501 [8]), expressed in milliseconds.

Minimum = 1. Maximum = 4095. Default = 2000..

AverWindowRm

integer

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

MaxDataBurstVol

Integer

Unsigned integer indicating Maximum Data Burst Volume (see clauses 5.7.3.7 and 5.7.4 of 3GPP TS 23.501 [8]), expressed in Bytes.

Minimum = 1. Maximum = 4095.

MaxDataBurstVolRm

Integer

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

SamplingRatio

Integer

Unsigned integer indicating Sampling Ratio (see clauses 4.15.1 of 3GPP TS 23.502 [28], expressed in percent.

Minimum = 1. Maximum = 100

SamplingRatioRM

Integer

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

RgWirelineCharacteristics

Bytes

RG Level Wireline Access Characteristics (see BBF TR-456 [41] and BBF TR-470 [37]). It shall be encoded as a string with format "byte" as defined in OpenAPI Specification [3], i.e. base64 encoded characters, representing the RG-Level Wireline Access Characteristics encoded as specified in clause 7.5 of BBF TR-470 [37].

RgWirelineCharacteristicsRm

Bytes

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

ExtMaxDataBurstVol

Integer

Unsigned integer indicating Maximum Data Burst Volume (see clauses 5.7.3.7 and 5.7.4 of 3GPP TS 23.501 [8]), expressed in Bytes.

Minimum = 4096. Maximum = 2000000.

ExtMaxDataBurstVolRm

Integer

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

ExtPacketDelBudget

Integer

Unsigned integer indicating Packet Delay Budget (see clauses 5.7.3.4 and 5.7.4 of 3GPP TS 23.501 [8])), expressed in 0.01 milliseconds.

Minimum = 1.

ExtPacketDelBudgetRm

Integer

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

NOTE: The prefixes used for bit rate unit "bps" shall be taken as x1000 multipliers and were meant to follow the standard symbols from "The International System of Units" (https://www.bipm.org/en/measurement-units/si-prefixes).
However, even when the standard symbol for 10^3 multiplier is "k", in the present specification it has been defined as "K", and has been kept as such due to backwards-compatibility with earlier versions of this specification.

5.5.3 Enumerations

5.5.3.1 Enumeration: PreemptionCapability

The enumeration PreemptionCapability indicates the pre-emption capability of a request on other QoS flows. See clause 5.7.2.2 of 3GPP TS 23.501 [8]. It shall comply with the provisions defined in table 5.5.3.1-1.

Table 5.5.3.1-1: Enumeration PreemptionCapability

Enumeration value

Description

"NOT_PREEMPT"

Shall not trigger pre-emption.

"MAY_PREEMPT"

May trigger pre-emption.

5.5.3.2 Enumeration: PreemptionVulnerability

The enumeration PreemptionVulnerability indicates the pre-emption vulnerability of the QoS flow to pre-emption from other QoS flows. See clause 5.7.2.2 of 3GPP TS 23.501 [8]. It shall comply with the provisions defined in table 5.5.3.2-1.

Table 5.5.3.2-1: Enumeration PreemptionVulnerability

Enumeration value

Description

"NOT_PREEMPTABLE"

Shall not be pre-empted.

"PREEMPTABLE"

May be pre-empted.

5.5.3.3 Enumeration: ReflectiveQosAttribute

The enumeration ReflectiveQosAttribute indicates whether certain traffic of the QoS flow may be subject to Reflective QoS (see clause 5.7.2.3 of 3GPP TS 23.501 [8]). It shall comply with the provisions defined in table 5.5.3.3-1.

Table 5.5.3.3-1: Enumeration ReflectiveQosAttribute

Enumeration value

Description

"RQOS"

Certain traffic of the Qos flow may be subject to Reflective QoS.

"NO_RQOS"

Traffic of the Qos flow is not subject to Reflective QoS.

5.5.3.4 Void

5.5.3.5 Enumeration: NotificationControl

The enumeration NotificationControl indicates whether notifications are requested from the RAN when the GFBR can no longer (or again) be fulfilled for a QoS Flow during the lifetime of the QoS Flow (see clause 5.7.2.4 of 3GPP TS 23.501 [8]). It shall comply with the provisions defined in table 5.5.3.5-1.

Table 5.5.3.5-1: Enumeration NotificationControl

Enumeration value

Description

"REQUESTED"

Notifications are requested from the RAN.

"NOT_REQUESTED"

Notifications are not requested from the RAN.

5.5.3.6 Enumeration: QosResourceType

The enumeration QosResourceType indicates whether a QoS Flow is non-GBR, delay critical GBR, or non-delay critical GBR (see clauses 5.7.3.4 and 5.7.3.5 of 3GPP TS 23.501 [8]). It shall comply with the provisions defined in table 5.5.3.6-1.

Table 5.5.3.6-1: Enumeration QosResourceType

Enumeration value

Description

"NON_GBR"

Non-GBR QoS Flow.

"NON_CRITICAL_GBR"

Non-delay critical GBR QoS flow.

"CRITICAL_GBR"

Delay critical GBR QoS flow.

5.5.3.7 Enumeration: PreemptionCapabilityRm

This enumeration is defined in the same way as the "PreemptionCapability" enumeration, but with the OpenAPI "nullable: true" property.

5.5.3.8 Enumeration: PreemptionVulnerabilityRm

This enumeration is defined in the same way as the "PreemptionVulnerability" enumeration, but with the OpenAPI "nullable: true" property.

5.5.3.9 Enumeration: ReflectiveQosAttributeRm

This enumeration is defined in the same way as the "ReflectiveQosAttribute" enumeration, but with the OpenAPI "nullable: true" property.

5.5.3.10 Enumeration: NotificationControlRm

This enumeration is defined in the same way as the "NotificationControl" enumeration, but with the OpenAPI "nullable: true" property.

5.5.3.11 Enumeration: QosResourceTypeRm

This enumeration is defined in the same way as the "QosResourceType" enumeration, but with the OpenAPI "nullable: true" property.

5.5.3.12 Enumeration: AdditionalQosFlowInfo

The enumeration AdditionalQosFlowInfo provides additional QoS flow information (see clause 9.3.1.12 3GPP TS 38.413 [11]). It shall comply with the provisions defined in table 5.5.3.12-1.

Table 5.5.3.12-1: Enumeration AdditionalQosFlowInfo

Enumeration value

Description

"MORE_LIKELY"

Traffic for the QoS flow is likely to appear more often than traffic for other flows established for the PDU session.

5.5.3.13 Enumeration: PartitioningCriteria

The enumeration PartitioningCriteria indicates criteria for grouping the UEs (see clause 4.15.1 of 3GPP TS 23.502 [28]). It shall comply with the provisions defined in table 5.5.3.13-1.

Table 5.5.3.13-1: Enumeration PartitioningCriteria

Enumeration value

Description

"TAC"

Type Allocation Code

"SUBPLMN"

Subscriber PLMN ID

"GEOAREA"

Geographical area

"SNSSAI"

S-NSSAI

"DNN"

DNN

5.5.3.14 Enumeration: PartitioningCriteriaRm

This enumeration is defined in the same way as the "PartitioningCriteria" enumeration, but with the OpenAPI "nullable: true" property.

5.5.4 Structured Data Types

5.5.4.1 Type: Arp

Table 5.5.4.1-1: Definition of type Arp

Attribute name

Data type

P

Cardinality

Description

priorityLevel

ArpPriorityLevel

M

1

Defines the relative importance of a resource request.

preemptCap

PreemptionCapability

M

1

Defines whether a service data flow may get resources that were already assigned to another service data flow with a lower priority level.

preemptVuln

PreemptionVulnerability

M

1

Defines whether a service data flow may lose the resources assigned to it in order to admit a service data flow with higher priority level.

5.5.4.2 Type: Ambr

Table 5.5.4.2-1: Definition of type Ambr

Attribute name

Data type

P

Cardinality

Description

uplink

BitRate

M

1

AMBR for uplink

downlink

BitRate

M

1

AMBR for downlink

5.5.4.3 Type: Dynamic5Qi

Table 5.5.4.3-1: Definition of type Dynamic5Qi

Attribute name

Data type

P

Cardinality

Description

Applicability

resourceType

QosResourceType

M

1

Defines the 5QI resource type. See clause 5.5.3.6.

priorityLevel

5QiPriorityLevel

M

1

Defines the 5QI Priority Level. See clause 5.5.2.

packetDelayBudget

PacketDelBudget

M

1

Defines the packet delay budget. See clause 5.5.2.

See NOTE 3.

packetErrRate

PacketErrRate

M

1

Defines the packet error rate. See clause 5.5.2.

averWindow

AverWindow

C

0..1

Defines the averaging window. See clause 5.5.2.

This IE shall be present only for a GBR QoS flow or a Delay Critical GBR QoS flow.

maxDataBurstVol

MaxDataBurstVol

C

0..1

Defines the maximum data burst volume. See clause 5.5.2.

See NOTE 1, NOTE 2.

This IE shall be present for a Delay Critical GBR QoS flow.

extMaxDataBurstVol

ExtMaxDataBurstVol

C

0..1

Defines the maximum data burst volume. See clause 5.5.2.

See NOTE 1, NOTE 2.

extPacketDelBudget

ExtPacketDelBudget

O

0..1

Defines the packet delay budget. See clause 5.5.2.

See NOTE 3.

cnPacketDelayBudgetDl

ExtPacketDelBudget

O

0..1

Defines the Core Network Packet Delay Budget for downlink.

See clause 5.5.2.

cnPacketDelayBudgetUl

ExtPacketDelBudget

O

0..1

Defines the Core Network Packet Delay Budget for uplink.

See clause 5.5.2.

NOTE 1: Unless specified otherwise in an API: if the maximum data burst volume value to be transmitted is lower than or equal to 4095 Bytes, the maxDataBurst Vol IE shall be set to the maximum data burst volume value to be transmitted and the extMaxDataBurstVol IE shall be omitted. If the maximum data burst volume value to be transmitted is greater than 4095 Bytes, the maxDataBurst Vol IE shall be set to 4095 Bytes and, if ExtMaxDataBurstVol data type is supported by the sender, the extMaxDataBurstVol IE shall be set to the maximum data burst volume value to be transmitted.

NOTE 2: Unless specified otherwise in an API: if both the maxDataBurstVol IE and the extMaxDataBurstVol IE are received, the value in the extMaxDataBurstVol IE shall be used if the receiver supports ExtMaxDataBurstVol data type, otherwise the value in the maxDataBurstVol IE shall be used.

NOTE 3: Unless specified otherwise in an API: if both the packetDelayBudget IE and the extPacketDelBudget IE are received, the value in the extPacketDelBudget IE shall be used if the receiver supports ExtPacketDelBudget data type, otherwise the value in the packetDelayBudget IE shall be used.

5.5.4.4 Type: NonDynamic5Qi

Table 5.5.4.4-1: Definition of type NonDynamic5Qi

Attribute name

Data type

P

Cardinality

Description

Applicability

priorityLevel

5QiPriorityLevel

O

0..1

Defines the 5QI Priority Level. See clause 5.5.2.

When present, it contains the 5QI Priority Level value that overrides the standardized or pre-configured value.

averWindow

AverWindow

O

0..1

Defines the averaging window. See clause 5.5.2.

This IE may be present for a GBR QoS flow or a Delay Critical GBR QoS flow. When present, it contains the Averaging Window that overrides the standardized or pre-configured value.

maxDataBurstVol

MaxDataBurstVol

O

0..1

Defines the maximum data burst volume. See clause 5.5.2.

This IE may be present for a Delay Critical GBR QoS flow. When present, it contains the Maximum Data Burst Volume value that overrides the standardized or pre-configured value.

See NOTE 1, NOTE 2.

extMaxDataBurstVol

ExtMaxDataBurstVol

C

0..1

Defines the maximum data burst volume. See clause 5.5.2.

This IE may be present for a Delay Critical GBR QoS flow. When present, it contains the Maximum Data Burst Volume value that overrides the standardized or pre-configured value

See NOTE 1, NOTE 2.

cnPacketDelayBudgetDl

ExtPacketDelBudget

O

0..1

Defines the Core Network Packet Delay Budget for downlink.

See clause 5.5.2.

cnPacketDelayBudgetUl

ExtPacketDelBudget

O

0..1

Defines the Core Network Packet Delay Budget for uplink.

See clause 5.5.2.

NOTE 1: Unless specified otherwise in an API: if the maximum data burst volume value to be transmitted is lower than or equal to 4095 Bytes, the maxDataBurst Vol IE shall be set to the maximum data burst volume value to be transmitted and the extMaxDataBurstVol IE shall be omitted. If the maximum data burst volume value to be transmitted is greater than 4095 Bytes, the maxDataBurst Vol IE shall be set to 4095 Bytes and, if ExtMaxDataBurstVol data type is supported by the sender, the extMaxDataBurstVol IE shall be set to the maximum data burst volume value to be transmitted.

NOTE 2: Unless specified otherwise in an API: if both the maxDataBurstVol IE and the extMaxDataBurstVol IE are received, the value in the extMaxDataBurstVol IE shall be used if the receiver supports ExtMaxDataBurstVol data type, otherwise the value in the maxDataBurstVol IE shall be used.

5.5.4.5 Type: ArpRm

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

5.5.4.6 Type: AmbrRm

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

5.5.4.7 Void

5.5.4.8 Void

5.5.4.9 Type: SliceMbr

Table 5.5.4.9-1: Definition of type SliceMbr

Attribute name

Data type

P

Cardinality

Description

uplink

BitRate

M

1

MBR for uplink

downlink

BitRate

M

1

MBR for downlink

5.5.4.10 Type: SliceMbrRm

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