Skip to main content

HS.FHIR.vSTU3.Model.Base.Address

deprecated class HS.FHIR.vSTU3.Model.Base.Address extends HS.FHIR.vSTU3.Model.Base.Element

THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
An address expressed using postal conventions (as opposed to GPS or other location definition formats). This data type may be used to convey addresses for use in delivering mail as well as for visiting locations which might not be valid for mail delivery. There are a variety of postal address formats defined around the world.
If the element is present, it must have a value for at least one of the defined elements, an @id referenced from the Narrative, or extensions

Property Inventory

Method Inventory

Parameters

parameter ELEMENTQUALIFIED = 1;
Inherited description: ELEMENTQUALIFIED controls the format of exported XML. The ELEMENTQUALIFIED specification should be based on the elementFormDefault attribute of the schema that defines the type. To maintain compatibility, ELEMENTQUALIFIED will default to 1 (true) for literal format export and will default to 0 (false) for encoded or encoded12 format export. These were the values always previously assumed for the elementFormDefault attribute. NOTE: Direct use of XMLExport method does not support the ELEMENTQUALIFIED. The export must be done using %XML.Writer or SOAP support.
parameter JSONTYPEFIELD;
Inherited description: Type property name for JSON export.
parameter XMLNAME = Address;
Inherited description: This parameter provides the default XMLNAME for the class. If it is empty then the class name will be used to construct a default XML name. The default XMLNAME is used as the top level tag when exporting objects and the export context did not provide an XML container name.
parameter XMLSEQUENCE = 1;
Inherited description: If the XMLSEQUENCE = 1, then the order of the XML elements must match the order of the class properties. This allows us to deal with XML where the same field appears multiple times and is distinguished by the order.

Properties

property city as HS.FHIR.vSTU3.Model.Datatype.String (XMLNAME = "city", XMLPROJECTION = "ELEMENT");
The name of the city, town, village or other community or delivery center.
Property methods: cityGet(), cityGetSwizzled(), cityIsValid(), cityNewObject(), citySet()
property country as HS.FHIR.vSTU3.Model.Datatype.String (XMLNAME = "country", XMLPROJECTION = "ELEMENT");
Country - a nation as commonly understood or generally accepted.
Property methods: countryGet(), countryGetSwizzled(), countryIsValid(), countryNewObject(), countrySet()
property district as HS.FHIR.vSTU3.Model.Datatype.String (XMLNAME = "district", XMLPROJECTION = "ELEMENT");
The name of the administrative area (county).
Property methods: districtGet(), districtGetSwizzled(), districtIsValid(), districtNewObject(), districtSet()
property line as list of HS.FHIR.vSTU3.Model.Datatype.String (XMLNAME = "line", XMLPROJECTION = "ELEMENT");
This component contains the house number, apartment number, street name, street direction, P.O. Box number, delivery hints, and similar address information.
Property methods: lineBuildValueArray(), lineCollectionToDisplay(), lineCollectionToOdbc(), lineDisplayToCollection(), lineGet(), lineGetObject(), lineGetObjectId(), lineGetSwizzled(), lineIsValid(), lineOdbcToCollection(), lineSet(), lineSetObject(), lineSetObjectId()
property period as HS.FHIR.vSTU3.Model.Base.Period (XMLNAME = "period", XMLPROJECTION = "ELEMENT");
Time period when address was/is in use.
Property methods: periodGet(), periodGetSwizzled(), periodIsValid(), periodNewObject(), periodSet()
property postalCode as HS.FHIR.vSTU3.Model.Datatype.String (XMLNAME = "postalCode", XMLPROJECTION = "ELEMENT");
A postal code designating a region defined by the postal service.
Property methods: postalCodeGet(), postalCodeGetSwizzled(), postalCodeIsValid(), postalCodeNewObject(), postalCodeSet()
property state as HS.FHIR.vSTU3.Model.Datatype.String (XMLNAME = "state", XMLPROJECTION = "ELEMENT");
Sub-unit of a country with limited sovereignty in a federally organized country. A code may be used if codes are in common use (i.e. US 2 letter state codes).
Property methods: stateGet(), stateGetSwizzled(), stateIsValid(), stateNewObject(), stateSet()
property text as HS.FHIR.vSTU3.Model.Datatype.String (XMLNAME = "text", XMLPROJECTION = "ELEMENT");
A full text representation of the address.
Property methods: textGet(), textGetSwizzled(), textIsValid(), textNewObject(), textSet()
property type as HS.FHIR.vSTU3.Model.Base.AddressType (XMLNAME = "type", XMLPROJECTION = "ELEMENT");
Distinguishes between physical addresses (those you can visit) and mailing addresses (e.g. PO Boxes and care-of addresses). Most addresses are both.
Property methods: typeGet(), typeGetSwizzled(), typeIsValid(), typeNewObject(), typeSet()
property use as HS.FHIR.vSTU3.Model.Base.AddressUse (XMLNAME = "use", XMLPROJECTION = "ELEMENT");
The purpose of this address.
Property methods: useGet(), useGetSwizzled(), useIsValid(), useNewObject(), useSet()

Methods

deprecated method SetCity(pValue As %String = "", pExtension As %RegisteredObject = "", pId As %String = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Set method for the "city" property.
deprecated method SetCountry(pValue As %String = "", pExtension As %RegisteredObject = "", pId As %String = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Set method for the "country" property.
deprecated method SetDistrict(pValue As %String = "", pExtension As %RegisteredObject = "", pId As %String = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Set method for the "district" property.
deprecated method SetLine(pValue As %String = "", pExtension As %RegisteredObject = "", pId As %String = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Insert method for the "line" property.
deprecated method SetPeriod(pStart As %String = "", pEnd As %String = "", pExtension As %RegisteredObject = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Set method for the "period" property.
deprecated method SetPostalCode(pValue As %String = "", pExtension As %RegisteredObject = "", pId As %String = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Set method for the "postalCode" property.
deprecated method SetState(pValue As %String = "", pExtension As %RegisteredObject = "", pId As %String = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Set method for the "state" property.
deprecated method SetText(pValue As %String = "", pExtension As %RegisteredObject = "", pId As %String = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Set method for the "text" property.
deprecated method SetType(pValue As %String = "", pExtension As %RegisteredObject = "", pId As %String = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Set method for the "type" property.
deprecated method SetUse(pValue As %String = "", pExtension As %RegisteredObject = "", pId As %String = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Set method for the "use" property.

Inherited Members

Inherited Properties

Inherited Methods

Feedback