Content for TS 29.571 Word version: 19.4.0

1… 5… 5.3… 5.4… 5.5… 5.6… 5.7… 5.8… 5.9… 5.10… 5.11… 5.12… A…

5.9 Data Types related to MBS 5.9.1 Introduction 5.9.2 Simple Data Types 5.9.3 Enumerations 5.9.4 Structured Data Types
...

5.9 Data Types related to MBS |R17| p. 148

5.9.1 Introduction p. 148

This clause defines common data types related to MBS.

5.9.2 Simple Data Types p. 148

This clause specifies common simple data types.

Table 5.9.2-1: Simple Data Types

Type Name	Type Definition	Description
AreaSessionId	Uint16	Area Session Identifier used for MBS session with location dependent content. When present, the Area Session ID together with the TMGI uniquely identifies the MBS session in a specific MBS service area.
AreaSessionPolicyId	Uint16	Area Session Policy ID used for MBS session with location dependent content.
MbsFsaId	string	MBS Frequency Selection Area ID, for a broadcast MBS session The value of the MbsFsaId 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 most significant character representing the 4 most significant bits of the MBS FSA Id shall appear first in the string, and the character representing the 4 least significant bit of the MBS FSA Id shall appear last in the string. Pattern: '^[A-Fa-f0-9]{6}$'
IntendedServiceArea	Bytes	String with format "byte" as defined in OpenAPI Specification [3], i.e. base64-encoded characters, encoding the value of the Intended Service Area IE defined in clause 9.3.1.x of TS 38.413.

5.9.3 Enumerations p. 149

5.9.3.1 Enumeration: MbsServiceType p. 149

The enumeration MbsServiceType indicates the type of MBS session. It shall comply with the provisions defined in Table 5.9.3.1-1.

Table 5.9.3.1-1: Enumeration MbsServiceType

Enumeration value	Description	Applicability
"MULTICAST"	Multicast MBS session
"BROADCAST"	Broadcast MBS session

5.9.3.2 Enumeration: MbsSessionActivityStatus p. 149

The enumeration MbsSessionActivityStatus indicates the MBS session's activity status. It shall comply with the provisions defined in Table 5.9.3.2-1.

Table 5.9.3.2-1: Enumeration MbsSessionActivityStatus

Enumeration value	Description	Applicability
"ACTIVE"	Active MBS session
"INACTIVE"	Inactive MBS session

5.9.3.3 Enumeration: MbsSessionEventType p. 150

Table 5.9.3.3-1: Enumeration MbsSessionEventType

Enumeration value	Description	Applicability
"MBS_REL_TMGI_EXPIRY"	Subscription to be notified or notification request about the MBS session release due to TMGI expiry.
"BROADCAST_DELIVERY_STATUS"	Subscription to be notified or notification request about the MBS session broadcast delivery status.
"INGRESS_TUNNEL_ADD_CHANGE"	Subscription to be notified or notification request about change of the Ingress Tunnel Address, when using unicast transport over N6mb/Nmb9.

5.9.3.4 Enumeration: BroadcastDeliveryStatus p. 150

Table 5.9.3.4-1: Enumeration BroadcastDeliveryStatus

Enumeration value	Description	Applicability
"STARTED"	The MBS session has been started.
"TERMINATED"	The MBS session has been terminated.

5.9.3.5 Enumeration: NrRedCapUeInfo |R18| p. 150

The enumeration NrRedCapUeInfo indicates NR RedCap Information of the broadcast MBS session. It shall comply with the provisions defined in Table 5.9.3.5-1.

Table 5.9.3.5-1: Enumeration NrRedCapUeInfo

Enumeration value	Description	Applicability
"NR_REDCAP_UE_ONLY"	Indicates that the MBS session is expected to be received only by NR (e)RedCap UEs.
"BOTH_NR_REDCAP_UE_AND_NON_REDCAP_UE"	Indicates that the MBS session is expected to be received by any kind of UEs.
"NON_REDCAP_UE_ONLY"	Indicates that the MBS session is expected to be received only by non-RedCap UEs, i.e. UEs that are neither NR RedCap UEs nor NR eRedCap UEs.

5.9.4 Structured Data Types p. 150

5.9.4.1 Type: MbsSessionId p. 150

Table 5.9.4.1-1: Definition of type MbsSessionId

Attribute name	Data type	P	Cardinality	Description
tmgi	Tmgi	C	0..1	TMGI identifying the MBS session (NOTE)
ssm	Ssm	C	0..1	Source specific IP multicast address identifying the MBS session (NOTE)
nid	Nid	O	0..1	Network Identity used together with the TMGI to identify an MBS session in an SNPN
NOTE: At least one of the tmgi IE and ssm IE shall be present.

5.9.4.2 Type: Tmgi p. 151

Table 5.9.4.2-1: Definition of type Tmgi

Attribute name	Data type	P	Cardinality	Description
mbsServiceId	string	M	1	MBS Service ID consisting of a 6-digit fixed-length hexadecimal number between 000000 and FFFFFF. 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 MBS Service ID shall appear first in the string, and the character representing the 4 least significant bit of the MBS Service ID shall appear last in the string. Pattern: '^[A-Fa-f0-9]{6}$'
plmnId	PlmnId	M	1	PLMN ID

5.9.4.3 Type: Ssm p. 151

Table 5.9.4.3-1: Definition of type Ssm

Attribute name	Data type	P	Cardinality	Description
sourceIpAddr	IpAddr	M	1	IP unicast address used as source address in IP packets for identifying the source of the multicast service (e.g. AF/AS).
destIpAddr	IpAddr	M	1	IP multicast address used as destination address in related IP packets for identifying the multicast service associated with the source.

5.9.4.4 Type: MbsServiceArea p. 151

Table 5.9.4.4-1: Definition of type MbsServiceArea

Attribute name	Data type	P	Cardinality	Description
ncgiList	array(NcgiTai)	C	1..N	List of NR cell ids with their pertaining TAIs (NOTE 1, NOTE 3).
taiList	array(Tai)	C	1..N	List of tracking area Ids (NOTE 1).
intendedServAreaList	array(IntendedServiceArea)	O	1..N	List of NR NTN Intended Service Areas (NOTE 2)
NOTE 1: The MBS Service Area consists of the union of the cells in the tracking areas listed in the taiList IE and the cells listed in the ncgiList IE. At least one of the ncgiList IE and taiList IE shall be present. NOTE 2: The NR NTN Intended Service Area may be sent by the NEF/MBSF to the NG-RAN, via the MB-SMF and AMF, to further restrict the MBS service area. It contains information that shall only be used by the NG-RAN, i.e. the MB-SMF and AMF shall transfer this information transparently. See TS 23.247. NOTE 3: In case of NR NTN, the cell IDs contained in the MBS service area may correspond to mapped cell IDs as defined in TS 38.300.

5.9.4.5 Type: NcgiTai p. 152

Table 5.9.4.5-1: Definition of type NcgiTai

Attribute name	Data type	P	Cardinality	Description
tai	Tai	M	1	TAI of the cells in cellList (NOTE)
cellList	array(Ncgi)	M	1..N	List of NR cell ids
NOTE: The NcgiTai consists of the list of cells listed in the cellList IE. These cells pertain to the TAI indicated in the tai IE. The TAI may be used e.g. to discover and select an AMF that serves NG-RAN nodes supporting the corresponding cells.

5.9.4.6 Type: MbsSession p. 153

Table 5.9.4.6-1: Definition of type MbsSession

Attribute name	Data type	P	Cardinality	Description
mbsSessionId	MbsSessionId	C	0..1	MBS session identifier (TMGI and/or SSM, and NID for an SNPN) (NOTE 1)
tmgiAllocReq	boolean	C	0..1	TMGI allocation request indication. This IE shall be present if the mbsSessionId IE is absent. This IE may also be present if the mbsSessionId IE is present and it does not contain a TMGI. When present, it shall be set as follows: true: a TMGI is requested to be allocated false (default): no TMGI is requested to be allocated Write-Only: true (NOTE 1)
tmgi	Tmgi	C	0..1	This IE shall be present in an MBS session creation response if the tmgiAllocReq IE was present and set to "true" in the MBS session creation request. When present, it shall indicate the TMGI allocated to the MBS session. Read-Only: true
expirationTime	DateTime	C	0..1	This IE shall be present in an MBS session creation response if the tmgiAllocReq IE was present and set to "true" in the in the MBS session creation request. When present, it shall indicate the expiration time for the TMGI allocated to the MBS session. Read-Only: true
serviceType	MbsServiceType	M	1	MBS Service Type (either multicast or broadcast service) Write-Only: true
locationDependent	boolean	C	0..1	Location dependent MBS session indication. This IE shall be present and set to true for a Location dependent MBS session. It may be present otherwise. When present, it shall be set as follows: true: this is a Location dependent MBS session false (default): this is not a Location dependent MBS session
areaSessionId	AreaSessionId	C	0..1	This IE shall be present in a successful response to a request to create an instance of a Location dependent MBS session i.e. when the "locationDependent" attribute is present and set to "true" in the MBS session creation request. When present, it shall contain the Area Session ID assigned by the MB-SMF to the location dependent MBS session instance in the MBS Service Area. Read-Only: true
ingressTunAddrReq	boolean	O	0..1	Ingress transport address request indication (for unicast transport over N6mb/Nmb9). When present, it shall be set as follows: true: an ingress transport address is requested false (default): no request Write-Only: true
ingressTunAddr	array(TunnelAddress)	C	1..N	Ingress tunnel address (UDP/IP tunnel). This IE shall be present in an MBS session creation response if the ingressTunAddrReq IE was present and set to "true" in the corresponding MBS session creation request. When present, it shall indicate the allocated ingress tunnel address(es). Read-Only: true (NOTE 2)
ssm	Ssm	C	0..1	Source specific IP multicast address This IE shall be present if multicast transport applies over N6mb and the MBS session is not identified by the SSM, e.g. for a location-dependent MBS session with multicast transport over N6mb. Write-Only: true
mbsServiceArea	MbsServiceArea	O	0..1	Contains the MBS Service Area This attribute shall be present only for a location dependent MBS session or a local MBS session. Write-Only: true
extMbsServiceArea	ExternalMbsServiceArea	O	0..1	Contains the MBS service area. This attribute shall be present only for a location dependent MBS session or a local MBS session. This IE may be present only over the N33 interface; it shall not be present over other interfaces. When present, it shall indicate the MBS Service Area information which shall either be geographical area information or civic address information. Write-Only: true
redMbsServArea	MbsServiceArea	C	0..1	This attribute shall be present if the requested MBS service area is not entirely contained within the service area of a single MB-SMF. When present, it shall contain the reduced MBS Service Area in which the MBS session has been created. Read-Only: true (NOTE 3)
extRedMbsServArea	ExternalMbsServiceArea	C	0..1	This attribute shall be present if the requested MBS service area is not entirely contained within the service area of a single MB-SMF. This IE may be present only over the N33 interface; it shall not be present over other interfaces. When present, it shall contain the reduced MBS Service Area in which the MBS session has been created, which shall either be geographical area information or civic address information. Read-Only: true (NOTE 3)
dnn	Dnn	O	0..1	Represents the DNN Write-Only: true
snssai	Snssai	O	0..1	Represents the S-NSSAI Write-Only: true
activationTime	DateTime	O	0..1	Represents the MBS session start time. This attribute is deprecated and replaced by the "startTime" attribute.
startTime	DateTime	O	0..1	Represents the MBS session start time.
terminationTime	DateTime	O	0..1	Represents the MBS session termination time.
mbsServInfo	MbsServiceInfo	O	0..1	Contains the MBS Service Information for the MBS session.
mbsSessionSubsc	MbsSessionSubscription	O	0..1	Contains the parameters to request the creation of a subscription to one or more MBS session status event(s).
activityStatus	MbsSessionActivityStatus	O	0..1	Contains the session activity status (active or inactive). This IE may be provided if the "serviceType" attribute indicates a multicast MBS session.
anyUeInd	boolean	O	0..1	Indication that any UE may join the MBS session. This IE may be provided if the "serviceType" attribute indicates a multicast MBS session. When present, it shall be set as follows: true: any UE may join the MBS session false (default): the MBS session is not open to any UE Write-Only: true
mbsFsaIdList	array(MbsFsaId)	O	1..N	List of MBS Frequency Selection Area Identifiers, for a broadcast MBS session. This attribute may be present if the "serviceType" attribute indicates a broadcast MBS session.
associatedSessionId	AssociatedSessionId	O	0..1	Associated Session ID to enable NG-RAN to identify the multiple MBS sessions delivering the same content when AF creates multiple broadcast MBS Sessions via different Core Networks to deliver the same content.
nrRedCapUeInfo	NrRedCapUeInfo	O	0..1	Indicates whether the broadcast MBS session is intended only for NR (e)RedCap UEs, only for UEs that are neither NR RedCap UEs nor NR eRedCap UEs, or for any kind of UE.
NOTE 1: At least one of the mbsSessionId IE and tmgiAllocReq IE shall be present. Both may be present if the mbsSessionId IE does not contain a TMGI (i.e. if it only contains a SSM). NOTE 2: In a scenario where an MB-UPF covers a small service area (i.e. a list of TAIs that is a subset of the MBS service area), the MB-SMF needs to find other MB-UPF(s) to cover the whole MBS service area for the MBS session. In such scenarios, multiple ingress addresses of all MB-UPFs need to be allocated for an MBS session. These multiple ingress tunnel addresses are used to receive the same copy of the MBS session data from the AF/MBSTF. In such scenarios, the MBS service area served by an MB-UPF shall be larger than the MBS service area served by an AMF (set), i.e. an AMF in an AMF set shall receive only one MBS Session Information Request Transfer for an MBS session in the MBS Session Context Create/Update Request message. NOTE 3: These attributes are sent on different interfaces. Accordingly, they are mutually exclusive.

5.9.4.7 Type: MbsSessionSubscription p. 157

Table 5.9.4.7-1: Definition of type MbsSessionSubscription

Attribute name	Data type	P	Cardinality	Description
mbsSessionId	MbsSessionId	C	0..1	Identifier of the MBS Session for which the subscription is created. This IE shall be present, except for an MBS session subscription request that is sent within an MBS session creation request.
areaSessionId	AreaSessionId	C	0..1	Area Session ID, for a location dependent MBS session, identifying the part of the MBS session in an MBS service area for which the subscription is created. It shall be present for a location dependent MBS session, except for an MBS session subscription request that is sent within an MBS session creation request
eventList	array(MbsSessionEvent)	M	1..N	List of MBS session events subscribed
notifyUri	Uri	M	1	URI where the NF service consumer requests to receive MBS session notifications. Write-Only: true
notifyCorrelationId	string	O	0..1	Notification Correlation ID Write-Only: true
expiryTime	DateTime	O	0..1	When present in an MBS Session subscription creation request, it shall indicate the time up to which the subscription is desired to be kept active and after which the subscribed events shall stop generating notifications. When present in a subscription response, it shall indicate the expiry time after which the subscription becomes invalid.
nfcInstanceId	NfInstanceId	C	0..1	NF Instance ID of the NF Service Consumer This IE shall be present if available. Write-Only: true
mbsSessionSubscUri	Uri	C	0..1	This IE shall be present in the response to an MBS session creation request that includes a subscription to events about the MBS session and the subscription was created successfully. When present, it shall contain the URI of the individual subscription resource. Read-Only: true (NOTE)
NOTE: When an MBS session status subscription is created separately (i.e. after) an MBS session creation, the Location header returned in the MBS session status subscription creation response contains the URI of the created subscription.

5.9.4.8 Type: MbsSessionEventReportList p. 157

Table 5.9.4.8-1: Definition of type MbsSessionEventReportList

Attribute name	Data type	P	Cardinality	Description
eventReportList	array(MbsSessionEventReport)	M	1..N	List of MBS session events to report
notifyCorrelationId	string	C	0..1	Notification Correlation ID. This IE shall be present if a Notification Correlation ID is available in the subscription.

5.9.4.9 Type: MbsSessionEvent p. 158

Table 5.9.4.9-1: Definition of type MbsSessionEvent

Attribute name	Data type	P	Cardinality	Description	Applicability
eventType	MbsSessionEventType	M	1	MBS session event type

5.9.4.10 Type: MbsSessionEventReport p. 158

Table 5.9.4.10-1: Definition of type MbsSessionEventReport

Attribute name	Data type	P	Cardinality	Description
eventType	MbsSessionEventType	M	1	MBS session event type
timeStamp	DateTime	C	0..1	This IE shall contain the time at which the event is generated. This IE should be present, if available.
ingressTunAddrInfo	IngressTunAddrInfo	C	0..1	This IE shall be present if the eventType IE indicates "INGRESS_TUNNEL_ADD_CHANGE".
broadcastDelStatus	BroadcastDeliveryStatus	C	0..1	This IE shall be present if the eventType IE indicates "BROADCAST_DELIVERY_STATUS".

5.9.4.11 Type: ExternalMbsServiceArea p. 158

Table 5.9.4.11-1: Definition of type ExternalMbsServiceArea

Attribute name	Data type	P	Cardinality	Description
geographicAreaList	array(GeographicArea)	C	1..N	Identifies a list of geographic area specified by different shapes.
civicAddressList	array(CivicAddress)	C	1..N	Identifies a list of civic address.
NOTE: Either the geographicAreaList IE or the civicAddressList IE shall be present.

5.9.4.12 Type: MbsSecurityContext p. 158

Table 5.9.4.12-1: Definition of type MbsSecurityContext

Attribute name	Data type	P	Cardinality	Description
keyList	map(MbsKeyInfo)	M	1..N	One or more MSK/MTK(s) and associated IDs. The key of the map shall be a (unique) valid JSON string per Section 7 of RFC 8259, with a maximum of 32 characters

5.9.4.13 Type: MbsKeyInfo p. 159

Table 5.9.4.13-1: Definition of type MbsKeyInfo

Attribute name	Data type	P	Cardinality	Description
keyDomainId	Bytes	M	1	Key Domain ID = MCC \|\| MNC as defined in TS 33.246. (NOTE) It shall be encoded as a string with format "byte" as defined in OpenAPI Specification [3], i.e. base64-encoded characters, representing the Key Domain ID (encoded in 3 bytes).
mskID	Bytes	M	1	MSK ID as defined in TS 33.246. It shall be encoded as a string with format "byte" as defined in OpenAPI Specification [3], i.e. base64-encoded characters, representing the MSK ID (encoded in 4 bytes).
msk	Bytes	C	0..1	MSK as defined in TS 33.246. The IE shall not be present when MBSTF requests updated MSK from MBSF after, e.g. lifetime expiry. Shall be present otherwise. When present, it shall be encoded as a string with format "byte" as defined in OpenAPI Specification [3], i.e. base64-encoded characters, representing the MSK (encoded in 16 bytes).
mskLifetime	DateTime	O	0..1	MSK Lifetime as defined in TS 33.501.
mtkID	Bytes	C	0..1	MTK ID as defined in TS 33.246. Shall be present if available. It shall be encoded as a string with format "byte" as defined in OpenAPI Specification [3], i.e. base64-encoded characters, representing the MTK ID (encoded in 2 bytes).
mtk	Bytes	C	0..1	MTK as defined in TS 33.246. Shall be present if available. It shall be encoded as a string with format "byte" as defined in OpenAPI Specification [3], i.e. base64-encoded characters, representing the MTK (encoded in 16 bytes).
NOTE: For a multicast MBS session in a SNPN, the Key Domain ID for the MBS session should be encoded using MCC and MNC, in this case, it may not be unique.

5.9.4.14 Type: IngressTunAddrInfo p. 159

Table 5.9.4.14-1: Definition of type IngressTunAddrInfo

Attribute name	Data type	P	Cardinality	Description	Applicability
ingressTunAddr	array(TunnelAddress)	M	1..N	Ingress Tunnel Address(es) to use to send MBS session data over N6mb/Nmb9 and that replace any earlier provided Ingress Tunnel Address(es).

5.9.4.15 Type: MbsServiceAreaInfo p. 160

Table 5.9.4.15-1: Definition of type MbsServiceAreaInfo

Attribute name	Data type	P	Cardinality	Description
areaSessionId	AreaSessionId	M	1	Area Session Identifier used for MBS session with location dependent content.
mbsServiceArea	MbsServiceArea	M	1	MBS Service Area for MBS session with location dependent content.

5.9.4.16 Type: MbsServiceInfo p. 160

Table 5.9.4.16-1: Definition of type MbsServiceInfo

Attribute name	Data type	P	Cardinality	Description
mbsMediaComps	map(MbsMediaCompRm)	M	1..N	Contains the information of one or several media component(s). The key of the map is the "mbsMedCompNum" attribute of the corresponding MbsMediaCompRm data structure provided as a map entry.
mbsSdfResPrio	ReservPriority	O	0..1	Indicates the reservation priority of the MBS service data flow(s) identified by the "mbsMediaComps" attribute.
afAppId	AfAppId	O	0..1	Contains the AF application identifier.
mbsSessionAmbr	BitRate	O	0..1	Contains the required MBS Session-AMBR.

5.9.4.17 Type: MbsMediaComp p. 160

Table 5.9.4.17-1: Definition of type MbsMediaComp

Attribute name	Data type	P	Cardinality	Description
mbsMedCompNum	integer	M	1	Contains the ordinal number of the MBS media component.
mbsFlowDescs	array(FlowDescription)	O	1..N	Contains the flow description for the MBS Downlink IP flow(s).
mbsSdfResPrio	ReservPriority	O	0..1	Indicates the reservation priority for the MBS service data flow(s) identified by the "mbsFlowDescs" attribute. (NOTE 2)
mbsMediaInfo	MbsMediaInfo	O	0..1	Indicates the MBS media information. (NOTE 1)
qosRef	string	O	0..1	Contains the identifier to pre-defined MBS QoS. (NOTE 1)
mbsQoSReq	MbsQoSReq	O	0..1	Contains the MBS QoS requirements. (NOTE 1)
NOTE 1: Only one of these attributes may be present. NOTE 2: When present, the value of this attribute shall apply for the MBS service data flow(s) identified by this MBS Media Component. It shall take precedence over the value of the same attribute within the parent MbsServiceInfo data structure.

5.9.4.18 Type: MbsMediaCompRm p. 160

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

5.9.4.19 Type: MbsQoSReq p. 161

Table 5.9.4.19-1: Definition of type MbsQoSReq

Attribute name	Data type	P	Cardinality	Description
5qi	5Qi	M	1	Represents the required 5QI.
guarBitRate	BitRate	O	0..1	Contain the required 5GS guaranteed bit rate.
maxBitRate	BitRate	O	0..1	Contain the required 5GS maximum bit rate.
averWindow	AverWindow	C	0..1	Indicates the averaging window. This attribute shall be present only for a GBR QoS flow or a Delay Critical GBR QoS flow.
reqMbsArp	Arp	O	0..1	Indicates the requested allocation and retention priority.

5.9.4.20 Type: MbsMediaInfo p. 161

Table 5.9.4.20-1: Definition of type MbsMediaInfo

Attribute name	Data type	P	Cardinality	Description
mbsMedType	MediaType	O	0..1	Indicates the MBS media type.
maxReqMbsBwDl	BitRate	O	0..1	Contains the Maximum requested bandwidth.
minReqMbsBwDl	BitRate	O	0..1	Contains the Minimum requested bandwidth.
codecs	array(CodecData)	O	1..2	Indicates the codec data.

5.9.4.21 Data types describing alternative data types or combinations of data types |R18| p. 161

5.9.4.21.1 Type: AssociatedSessionId p. 161

Table 5.9.6.21.1-1: Definition of type AssociatedSessionId as a list of non-exclusive alternative data types

Data type	Cardinality	Description
Ssm	1	AssociatedSessionId encoded as an SSM.
string	1	AssociatedSessionId encoded as a string.