Address
A postal address, held as one string, as separate lines, city, district, state and postal code, or both.
- Kind
- Concrete class
- Attributes
- 10, 2 required
- NCI code
- C25407
Official definition
A standardized representation of the location of a person, business, building, or organization. (NCI)
In practice
In a protocol document: The sponsor's address on the title page; site addresses.
Attributes
10 attributes, 2 of them required by the USDM API schema.
| Attribute | Type | Card. | Definition |
|---|---|---|---|
| idrequired | string | cardinality 1 | The identifier of this object, unique within the file. |
| text | string | cardinality 0..1 | A standardized representation of the complete set of components denoting the physical address of the person, business, building, or organization. |
| lines | string | cardinality 0..* | The street name and number, building number, apartment or unit number, or post office box number where an entity is physically located. |
| district | string | cardinality 0..1 | An administrative or territorial division of a city, town, county, parish, state, country, or other locality based on a shared characteristic. |
| city | string | cardinality 0..1 | A relatively large and/or densely populated area of human habitation with administrative or legal status that may be specified as a component of a postal address. |
| postalCode | string | cardinality 0..1 | An alphanumeric code assigned to a mail delivery area. |
| state | string | cardinality 0..1 | A sub-division of a country that forms part of a federal union. States are usually, but not always, more autonomous than provinces and may have different laws from the central government. |
| country | Code | cardinality 0..1 | A sovereign nation occupying a distinct territory and ruled by an autonomous government.Values: ISO 3166-1 Alpha-3 Country code |
| extensionAttributes | ExtensionAttribute | cardinality 0..* | Extension attributes attached to this object, for information the standard does not define. Added by the API; not part of the logical model. |
| instanceTyperequired | string | cardinality 1 | The name of the class, carried by every object in a USDM JSON file. Added by the API; not part of the logical model. |
Smallest valid Address
The attributes a JSON file must carry for a Address, and the kind of value each takes. This is the shape, with types named in place of values. Everything else in the table above is optional.
Address, required attributes only
{
"id": "Address_1",
"instanceType": "Address"
}
Where Address is used
These classes hold or point to a Address.
- Organization.legalAddressnested
Related classes
Other classes in organizations, roles and sites: