Editing My 33.128 Notes (section)

== 5.7	Protocols for LI_HIQR ==

=== 5.7.1	General ===
Functions having an LI_HIQR interface shall support the use of ETSI TS 103 120 to realise the interface. [[My ETSI TS 103 120 Notes]]

In the event of a conflict between ETSI TS 103 120 and 33.128 document, the terms of 33.128 document shall apply.

:NOTE:	The terms identifier and identity are used interchangeably in clause 5.7.

=== 5.7.2 Usage for realising LI_HIQR ===

==== 5.7.2.1 Request structure ====

LI_HIQR requests are represented by issuing a CREATE request for an LDTaskObject (see ETSI TS 103 120 clause 8.3). LDTaskObject is populated as follows:

{| class="wikitable sortable"
|+ LDTaskObject representation of LI_HIQR request
|-
! Field !! Value !! M/C/O
|-
| Reference
| Reference to the authorization under which the request is made. The format of this field, and any procedures for allocating or validating it, are for national agreement.
| M
|-
| DesiredStatus
| Shall be set to "AwaitingDisclosure".
| M
|-
| RequestDetails
| Set according to RequestDetails structure grid below.
| M
|-
| DeliveryDetails
| Shall be set to indicate the delivery destination for the LI_HIQR records (see clause 5.7.2.3 and ETSI TS 103 120 clause 8.3.6.2) unless the delivery destination is known via other means.
| M
|}

The use of any other LDTaskObject parameter is outside the scope of 33.128 V18.0.0 (2022-06).

{| class="wikitable"
|+ RequestDetails structure
|-
! Type !! Value !! M/C/O
|-
| Type
| Shall be set to one of the RequestType values listed in RequestType Dictionary for LI_HIQR grid below.
| M
|-
| ObservedTime
| When the RequestValues provides a temporary identity, this field shall be set to the observation time of that temporary identity.

When the RequestValues provides a permanent identity, this is the time at which the LEA requires that the permanent to temporary association is applicable.

Shall not be present for requests of type "OngoingIdentityAssociation".
| C
|-
| RequestValues
| Set to the target identifier plus additional information required (see clause 5.7.2.2 Request Parameters).
| M
|}

:NOTE: If the observed time is in the past, providing a successful query response is subject to associations still being available in the cache when the query is made to the ICF.

{| class="wikitable"
|+ RequestType Dictionary for LI_HIQR
|-
! Dictionary Owner !! Dictionary Name
|-
| 3GPP
| RequestType
|}

{| class="wikitable"
|+ Defined DictionaryEntries
|-
! Value !! Meaning
|-
| IdentityAssociation
| A request for a single IdentityResponseDetails response to the query provided.
|-
| OngoingIdentityAssociation
| A request for an ongoing series of IdentityResponseDetails responses matching the query provided. May only be used when the RequestValues contains a permanent identifier. The request shall be terminated by updating the LDTaskObject DesiredStatus to "Disclosed".
|}

Grid Defined DictionaryEntries is formatted in accordance with ETSI TS 103 120 Annex F.

==== 5.7.2.2 Request parameters ====

The RequestValues field, a field within RequestDetails structure of LI_HIQR LDTaskObject, shall contain one of the following:
* SUPI, given in either SUPIIMSI or SUPINAI formats as defined in ETSI TS 103 120 clause C.2.
* SUCI, given as defined in grid below (table 5.7.2-4 in spec)
* 5G-S-TMSI, given as defined in grid below (table 5.7.2-4 in spec)
* 5G-GUTI, given as defined in grid below (table 5.7.2-4 in spec)

If the RequestType is "OngoingIdentityAssociation" (see table 5.7.2-3 in spec), SUPI is the only valid identity type in the RequestValues field. If the RequestType is "OngoingIdentityAssociation" and any other identity type is provided, the IQF shall signal the error by setting the LDTaskObject Status to "Invalid" (see ETSI TS 103 120 clause 8.3.3).

If a temporary identity is provided, the following shall also be present as RequestValues:
* NRCellIdentity, given as defined in grid below (table 5.7.2-4 in spec)
* TrackingAreaCode, given as defined in grid below (table 5.7.2-4 in spec)

The following RequestValue FormatTypes (see ETSI TS 103 120 clause 8.3.5.4) are defined (which are not otherwise defined outside 33.128).

{| class="wikitable sortable"
|+ RequestValue FormatType extensions for LI_HIQR Requests
|-
! Format Owner !! Format Name !! Description !! Format
|-
| 3GPP || SUCI || Subscription Concealed Identifier as per TS 23.003 clause 2.2B. || From TS 29.509 V18.0.0 clause 6.1.6.3.2: String containing a SUCI.
Pattern: "<code>^(suci-(0-[0-9]{3}-[0-9]{2,3}|[1-7]-.+)-[0-9]{1,4}-(0-0-.+|[a-fA-F1-9]-([1-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])-[a-fA-F0-9]+)|.+)$</code>"

|-
| 3GPP || 5GSTMSI || Shortened form of the 5G-GUTI as defined in TS 23.003 clause 2.11.

Given as a hyphen-separated concatenation of:
* The string "5gstmsi".
* The AMF Set ID given as three hexadecimal digits (10 bits).
* The AMF Pointer given as two hexadecimal digits (6 bits).
* The 5G-TMSI given as eight hexadecimal digits (32 bits)
|| Matches regular expression:

<code>^(5gstmsi-([0-3][0-9A-Fa-f]{2})-([0-3][0-9A-Fa-f])-([0-9A-Fa-f]{8}))$</code>
|-
| 3GPP || 5GGUTI || As defined in TS 23.003 clause 2.10. Given as a hyphen separated concatenation of:
* The string "5gguti".
* MCC given as a three decimal digits.
* MNC given as a two or three digit decimal digits
* AMF Region ID given as two hexadecimal digits (8 bits).
* The AMF Set ID, AMF Pointer and 5G-TMSI as defined above in 5GSTMSI
|| Matches regular expression:

<code>^(5gguti-([0-9]{3})-([0-9]{2,3})-([0-9A-Fa-f]{2})-([0-3][0-9A-Fa-f]{2})-([0-3][0-9A-Fa-f])-([0-9A-Fa-f]{8}))$</code>
|-
| 3GPP || NRCellIdentity || NR Cell ID (NCI), as defined in TS 23.003 clause 19.6A || TS 29.571 clause 5.4.2
|-
| 3GPP || TrackingAreaCode || Tracking area code as defined in TS 23.003 clause 19.4.2.3 || TS 29.571 clause 5.4.2
|}

==== 5.7.2.3 Response structure ====

The LI_HIQR request is used to generate a request to the ICF over LI_XQR (see clause 5.8). The response received over LI_XQR is then transformed into an LI_HIQR response.

LI_HIQR responses and updates are represented as XML following the IdentityResponseDetails type definition (see Annex E).

''Responses and updates are delivered within a DELIVER Request'' (see ETSI TS 103 120 clause 6.4.10) containing a DeliveryObject (see ETSI TS 103 120 clause 10).

IdentityResponseDetails contain IdentityAssociation records. The fields of each IdentityAssociationRecord shall be set as follows:

{| class="wikitable sortable"
|+ IdentityAssociationRecord
|-
! Field !! Value !! M/C/O
|-
| SUPI || SUPI associated with the provided identity. || M
|-
| SUCI|| SUCI associated with the provided identity, if available. || C
|-
| 5G-GUTI || 5G GUTI associated with the provided identity, provided in the form given in the request (see table 5.7.2-4). || M
|-
| PEI || PEI associated with the provided identity during the association period, if known. || C
|-
| AssociationStartTime || The time that the association between the SUPI and the temporary identity became valid. (see NOTE). || M
|-
| AssociationEndTime || The time that the association between the SUPI and the temporary identity ceased to be valid. Shall be omitted if the association is still valid (see NOTE). || C
|-
| FiveGSTAIList || List of tracking areas associated with the registration area within which the UE was or is registered in the lifetime of the reported association, if available. See clause 7.6.2.4 for details. || C
|-
| GPSI || GPSI associated with the provided identity during the association period, if known. || C
|}
:NOTE:	The AssociationStartTime and AssociationEndTime represent the lifespan of the SUPI to 5G-GUTI association. When a SUCI is present, the AssociationStartTime also represents the time of the SUCI's validity.

If no association is found which matches the criteria provided in the LI_XQR request, then the LI_XQR response contains zero IdentityAssociationRecords. Similarly, the LI_HIQR response contains zero IdentityAssociationRecords.

For responses or updates providing a currently valid SUPI to 5G-GUTI identity association, the AssociationEndTime shall be absent. The AssociationStartTime shall indicate when the 5G-GUTI became associated with the SUPI. The SUCI field shall be populated if it was present in the IEF record for the association (see clause 6.2.2A.2.1). The PEI and TAI List fields may be populated as well, see clause 7.6.2.4 for details.

In the case of ongoing updates, the presence of the AssociationEndTime indicates the SUPI to 5G-GUTI identity disassociation. Such updates shall only happen when no new association is replacing the outgoing one.

The DeliveryObject Reference field (see ETSI TS 103 120 clause 10.2.1) shall be set to the Reference of the LDTaskObject used in the request, to provide correlation between request and response. The DeliveryID, SequenceNumber and LastSequence fields shall be set according to ETSI TS 103 120 clause 10.2.1.

The content manifest (see ETSI TS 103 120 clause 10.2.2) shall be set to indicate the present document, using the following Specification Dictionary extension.

{| class="wikitable"
|+ Specification Dictionary
|-
! Dictionary Owner !! Dictionary Name
|-
| 3GPP || ManifestSpecification.
|}

{| class="wikitable"
|+ Defined DictionaryEntries
|-
! Value !! Meaning
|-
| LIHIQRResponse || The delivery contains IdentityResponseDetails (see Annex E)
|}