Related Entity

The Related Entity Related Component provides cross-reference information to key identifiers from other datasets, allowing for the linking of the UPRN (Unique Property Reference Number) to its associated feature types:

  • OS MasterMap Topographic Area TOID

  • OS MasterMap Highways Road Link TOID

  • OS NGD Administrative and Statistical Units Boundaries Parish or Community GSS Code

  • OS NGD Administrative and Statistical Units Ward GSS Code

  • Valuation Office Agency Council Tax Assessment UARN

  • Valuation Office Agency Non-Domestic Rate Assessment UARN

  • OS NGD Buildings Theme – Building Part Polygon OSID

  • OS NGD Structures Theme – Compound Structure OSID

  • OS NGD Structures Theme – Structure OSID

  • OS NGD Transport Theme – Road, Track, or Path Polygon OSID

  • OS NGD Transport Network Collection – Road Link OSID

  • OS NGD Land Theme – Land Cover Polygon OSID

  • OS NGD Water Theme – Water Polygon OSID

  • Channel Islands Unique Identifier (only available for the Islands Address Collection)

  • Channel Islands Street Identifier (only available for the Islands Address Collection)

  • Northern Ireland Street Identifier (only available for the Islands Address Collection)

  • Isle of Man Street Identifier (only available for the Islands Address Collection)

Data schema versioning

The following table provides details about this related component’s data schema versions, including the reasons behind the changes and the related launch date when each version went live.

Data schema version table

Version ↓
Launch Date
Latest Date
Change

2.0

28 March 2023

Ongoing

Major version increment to align with concurrent major version increments made to four feature types in the GB Address and Islands Address Collections: Built Address, Historic Address, Non-Addressable Object, and Pre-Build Address. (Related components follow the versioning of the addressing feature types they are associated with.) New attribution added to related component for Effective Start Date and Effective End Date.

1.0

02 November 2022

Ongoing

Initial launch of the Related Entity Related Component.

Please see Data schema versioning for in-depth information about data schema versioning in the OS NGD.

Temporal filtering

Temporal filtering allows you to order a one-off snapshot of data from the OS NGD from a current or past date. It is an optional step when you create a new data package in OS Select+Build (the OS NGD download service).

The earliest and latest dates on which you can request a one-off snapshot of a date in the past for this related component's data schema versions are indicated in the Data schema version table above. Please note that any data temporally filtered earlier than the specified launch date indicated in the table for the data schema versions may contain data inconsistencies.

More information about temporal filtering is available from the Getting started with temporal filtering guide.

The following sub-sections provide details about the attributes included with this related component, their data types in the different output formats, and other important metadata about them.

relatedentityid

Primary Key providing a unique row identifier assigned to enable indexing for efficient querying.

  • Data Types: String (GPKG), String (CSV)

  • Nullable: false

  • Max Length: 36

  • OS Select+Build Filterable: No

  • Data Schema Version: 1.0, 2.0

uprn

Unique Property Reference Number (UPRN) assigned by a local custodian or Ordnance Survey as a persistent identifier.

  • Data Types: Integer (GPKG), Integer (CSV)

  • Nullable: false

  • OS Select+Build Filterable: No

  • Data Schema Version: 1.0, 2.0

featuretypeversiondate

Date of the feature version to which this related entity applies.

  • Data Types: Date (GPKG), Date (CSV)

  • Nullable: false

  • OS Select+Build Filterable: No

  • Data Schema Version: 1.0, 2.0

crossreferencefeature

Description of the related dataset that the cross reference refers to, for example, VOA Council Tax.

  • Data Types: String (GPKG), String (CSV)

  • Nullable: false

  • Code List Name: dataentitycatalogue

  • Max Length: 40

  • OS Select+Build Filterable: No

  • Data Schema Version: 1.0, 2.0

crossreferenceid

Identifier of the related Data Entity or Feature Type instance that is the target of the reference or link.

  • Data Types: String (GPKG), String (CSV)

  • Nullable: false

  • Max Length: 36

  • OS Select+Build Filterable: No

  • Data Schema Version: 1.0, 2.0

relationshiptype

Type of relationship which has been formed between the source and target features, for example, Within, partOf or SameAs.

  • Data Types: String (GPKG), String (CSV)

  • Nullable: true

  • Code List Name: relationshiptypevalue

  • Max Length: 30

  • OS Select+Build Filterable: No

  • Data Schema Version: 1.0, 2.0

source

Name of the originating data provider that defined the reference or link.

  • Data Types: String (GPKG), String (CSV)

  • Nullable: false

  • Max Length: 110

  • OS Select+Build Filterable: No

  • Data Schema Version: 1.0, 2.0

updatedate

The date on which any attribute of the Record was last changed.

  • Data Types: Date (GPKG), Date (CSV)

  • Nullable: false

  • OS Select+Build Filterable: No

  • Data Schema Version: 1.0, 2.0

effectivestartdate

The date on which this relationship was first added into the database.

  • Data Types: Date (GPKG), Date (CSV)

  • Nullable: true

  • OS Select+Build Filterable: No

  • Data Schema Version: 2.0

effectiveenddate

The date on which the relationship ceased to exist.

  • Data Types: Date (GPKG), Date (CSV)

  • Nullable: true

  • OS Select+Build Filterable: No

  • Data Schema Version: 2.0

Last updated

Was this helpful?