JSDoc: Class: EntityAddress

new EntityAddress(copyData)

A structured address for an entity

Addresses in SanteDB are structured as a collection of components. This structure ensures that addresses a flexible when they are stored, searched and reproduced

Parameters:

Name	Type	Description
`copyData`	EntityAddress	Copy constructor (if present)

Properties:

Name Type Description

useModel Concept [Delay loaded from use], Gets or sets the address use

externId string Gets or sets the external key for the object

use string Gets or sets the address use key(see: AddressUseKeys for values)

component

object

Gets or sets the component types

Properties

Name	Type	Description
`AdditionalLocator`	string	An additional locator (example: Beside the red barn).
`AddressLine`	string	An address line as would appear on an address (example: 123 Main Street West)
`BuildingNumber`	string	Identifies a particular building on a street (example: A23 Building)
`BuildingNumberNumeric`	string	Identifies a numeric identifier for a building (example: 123)
`BuildingNumberSuffix`	string	Identifies a suffix to the building number (example: 123 SECTOR 7)
`CareOf`	string	Identifies the person where deliveries should be care-of (example: c/o Bob Smith)
`CensusTract`	string	The census tract which is used for political counting of the census
`City`	string	The town or city (example: Toronto)
`Country`	string	The country in which the address resides (example: Canada)
`County`	string	The county or sub-division of a sub-national unit (example: Clark County)
`Delimiter`	string	Represents a meaningless delimiter such as dash, or newline
`DeliveryAddressLine`	string	Represents an address line to be used for delivery rather than physical location (example: Loading Dock #4)
`DeliveryInstallationArea`	string	Represents the area where the delivery should take place
`DeliveryInstallationQualifier`	string	The delivery installation qualifier.
`DeliveryInstallationType`	string	The delivery installation type.
`DeliveryMode`	string	The delivery mode.
`DeliveryModeIdentifier`	string	The delivery mode identifier.
`Direction`	string	Represents a directory such as north, south, east, or west
`PostalCode`	string	A codified adminsitrative unit used to locate the address (zip code or postal code)
`PostBox`	string	Represents a PO box where delivery of mail should take place
`Precinct`	string	Represents a precinct or sub-division of a city such as a burrogh
`State`	string	Represents a state or province, or a sub-division of a national boundary
`StreetAddressLine`	string	Represents a physical street delivery line (example: 123 Main Street West)
`StreetName`	string	Represents the name portion of a street address (example: Main St.)
`StreetNameBase`	string	The street name base portion of a street address (Example: Main)
`StreetType`	string	The street type (example: Street, Road, Hwy)
`UnitDesignator`	string	Identifies the type of unit (example: Suite, Apartment, Unit)
`UnitIdentifier`	string	The identifier of the unit (example: 820)
`PlaceReference`	string	The identifier in the address that points to another
`Zone`	string	Identifies the region or zone or division
`$other`	string	Unclassified

modifiedOn Date

source string

sourceModel Entity [Delay loaded from source],

id string Gets or sets the primary identifying UUID of this object

operation BatchOperationType Gets or sets the operation(see: BatchOperationType for values)

$type string Gets the type registration of this object