From 03de57edeb1bcef552de59cbb549e9da57e5f675 Mon Sep 17 00:00:00 2001 From: Joshua Darnell Date: Wed, 10 Jul 2024 08:16:40 -0700 Subject: [PATCH] Update README.md Updated logo and other changes --- README.md | 25 ++++++++++++------------- 1 file changed, 12 insertions(+), 13 deletions(-) diff --git a/README.md b/README.md index 62b30cd..1c38542 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,4 @@ -![RESO-Logo-Fullname_Horizontal_Black-10](https://github.com/RESOStandards/reso-upi/assets/535358/a7daea5e-1f7e-408c-87a1-a2d97ca3814a) - + # Overview @@ -15,9 +14,9 @@ The UPI shape was designed to support different geographic methods of identifier ## UPI Data Elements The UPI uses the following data elements in its construction: * **Country** - an [**ISO 3166**](https://en.wikipedia.org/wiki/List_of_ISO_3166_country_codes) country code, e.g. US. -* **SubCountry** - a country-specific formula identifying the country subdivison of the authority that issued the parcel number. In the U.S., [**GEOIDs**](https://www.census.gov/programs-surveys/geography/guidance/geo-identifiers.html) are used. In the EU, [**NUTS**](https://ec.europa.eu/eurostat/web/nuts/overview) is used. Other countries may have their own country subdivisions. +* **Subcountry** - a country-specific formula identifying the country subdivison of the authority that issued the parcel number. In the U.S., [**GEOIDs**](https://www.census.gov/programs-surveys/geography/guidance/geo-identifiers.html) are used. In the EU, [**NUTS**](https://ec.europa.eu/eurostat/web/nuts/overview) is used. Other countries may have their own country subdivisions. * **ParcelNumber** - the [**parcel number**](https://ddwiki.reso.org/display/DDW20/ParcelNumber+Field) for a given real property. -* **SubParcelNumber** - the sub-parcel, when applicable. +* **Number** - the sub-parcel, when applicable. ## Uniform Resource Names (URNs) @@ -30,7 +29,7 @@ RESO has a reserved URN which includes v1 UPI identifiers. [**See section 3.4.2* The format of the UPI is as follows: ``` -urn:reso:upi::::[:sub:] +urn:reso:upi::::[:sub:] ``` where the items in angle brackets are required and the items in square brackets are optional. @@ -46,21 +45,21 @@ urn:reso:upi:2.0:US:48201:R000022230 * `urn:reso:upi:` is the stem, including URN prefix and UPI namespace. * `2.0` is the version of the UPI (version 1.0 was previously implemented by some companies). * `US` is the ISO 3166 code for the United States. -* `48201` is the SubCountry (_not to be confused with subcounty_) for Harrison County, TX, a GEOID from the U.S Census Bureau (the method for identifying Subcountry is country-specific). +* `48201` is the Subcountry (_not to be confused with subcounty_) for Harrison County, TX, a GEOID from the U.S Census Bureau (the method for identifying Subcountry is country-specific). * `R000022230` is the parcel number. -## Example: UPI with SubParcelNumber -UPIs can also be used to identify subparcel elements of a property, such as parking spaces, outbuildings or air rights. The UPI, with its fixed number of preparcel components separated by colons, can be extended with a `:sub:` component label followed by the subparcel item identifier. +## Example: UPI with Number +UPIs can also be used to identify elements of a property, such as parking spaces, outbuildings or air rights. The UPI, with its fixed number of preparcel components separated by colons, can be extended with a `:sub:` component label followed by the item identifier. ``` urn:reso:upi:2.0:US:48201:R000022230:sub:78 - 9.aB ``` * `:sub:` is the extended component label. -* `78 - 9.aB` is the subparcel identifier for one of many property elements on the parcel. +* `78 - 9.aB` is the identifier for one of many property elements on the parcel. -Since the core UPI contains a fixed number of colon-separated components, special characters that exist within components of the UPI are supported. Even colons within a parcel number will be identified as such because of the fixed number of preparcel components for the overall model. In the preceding example, the SubParcelNumber component has special characters. +Since the core UPI contains a fixed number of colon-separated components, special characters that exist within components of the UPI are supported. Even colons within a parcel number will be identified as such because of the fixed number of preparcel components for the overall model. In the preceding example, the Number component has special characters. # Considerations @@ -74,15 +73,15 @@ While unique parcel numbers are straightforward to identify in some geographies, RESO is conducting research and will document the correct ID data sets to be utilized by implementers as real-world issues are discovered in new geographies. -## Developing SubCountry Standards for More Countries -The UPI was created with the understanding that other countries will have different standards than the U.S. for how they identify the parcel-assigning authority. RESO will maintain continual outreach to international organizations to create consensus on how the SubCountry component for each of their geographies will be formed. +## Subcountry Standards Outside of the U.S. +The UPI was created with the understanding that other countries will have different standards than the U.S. for how they identify the parcel-assigning authority. RESO will maintain continual outreach to international organizations to create consensus on how the Subcountries component for each of their geographies will be formed. In the U.S., [**GEOIDs**](https://www.census.gov/programs-surveys/geography/guidance/geo-identifiers.html) are used. In the EU, [**NUTS**](https://ec.europa.eu/eurostat/web/nuts/overview) is used. Other countries may have their own country subdivisions. Questions? Please contact [**RESO**](mailto:info@reso.org). ## Retaining Raw Data from Sources -UPI parcel and subparcel components should match the raw data exactly, including capitals, dashes, special characters, spaces, etc. +UPI parcel and components should match the raw data exactly, including capitals, dashes, special characters, spaces, etc. With version 1.0 of UPI there was an effort to simplify identifiers through stripping some characters, but further research has shown that accuracy is improved when the entire original data set is retained, as in the UPI v2.0 model.