Skip to main content

HS.FHIR.DTL.vR4.Model.Datatype.Address

class HS.FHIR.DTL.vR4.Model.Datatype.Address extends HS.FHIR.DTL.vR4.Model.Base.Element

An address expressed using postal conventions (as opposed to GPS or other location definition formats)

Property 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 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 XMLPROJECTION = ELEMENT;
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.
parameter XMLTYPE = Address;
Inherited description: This parameter provides the default XMLTYPE for the class. If it is empty then the class name will be used to construct a default XML type. The default XMLTYPE is used when naming and referencing this type in a schema and the schema context did not provide an XML type name.

Properties

property city as %String (MAXLEN = 1000000, XMLNAME = "city", XMLPROJECTION = "ATTRIBUTE");
string

Name of city, town etc.

Property methods: cityDisplayToLogical(), cityGet(), cityIsValid(), cityLogicalToDisplay(), cityLogicalToOdbc(), cityNormalize(), citySet()
property country as %String (MAXLEN = 1000000, XMLNAME = "country", XMLPROJECTION = "ATTRIBUTE");
string

Country (e.g. can be ISO 3166 2 or 3 letter code)

Property methods: countryDisplayToLogical(), countryGet(), countryIsValid(), countryLogicalToDisplay(), countryLogicalToOdbc(), countryNormalize(), countrySet()
property district as %String (MAXLEN = 1000000, XMLNAME = "district", XMLPROJECTION = "ATTRIBUTE");
string

District name (aka county)

Property methods: districtDisplayToLogical(), districtGet(), districtIsValid(), districtLogicalToDisplay(), districtLogicalToOdbc(), districtNormalize(), districtSet()
property line as list of %String (MAXLEN = 1000000, XMLNAME = "line", XMLPROJECTION = "ELEMENT");
string

Street name, number, direction & P.O. Box etc.

Property methods: lineBuildValueArray(), lineCollectionToDisplay(), lineCollectionToOdbc(), lineDisplayToCollection(), lineDisplayToLogical(), lineGet(), lineGetObject(), lineGetObjectId(), lineGetSwizzled(), lineIsValid(), lineLogicalToDisplay(), lineLogicalToOdbc(), lineNormalize(), lineOdbcToCollection(), lineSet(), lineSetObject(), lineSetObjectId()
property period as HS.FHIR.DTL.vR4.Model.Datatype.Period (XMLNAME = "period", XMLPROJECTION = "ELEMENT");
Period

Time period when address was/is in use.

Property methods: periodGet(), periodGetSwizzled(), periodIsValid(), periodNewObject(), periodSet()
property postalCode as %String (MAXLEN = 1000000, XMLNAME = "postalCode", XMLPROJECTION = "ATTRIBUTE");
string

Postal code for area.

Property methods: postalCodeDisplayToLogical(), postalCodeGet(), postalCodeIsValid(), postalCodeLogicalToDisplay(), postalCodeLogicalToOdbc(), postalCodeNormalize(), postalCodeSet()
property state as %String (MAXLEN = 1000000, XMLNAME = "state", XMLPROJECTION = "ATTRIBUTE");
string

Sub-unit of country (abbreviations ok)

Property methods: stateDisplayToLogical(), stateGet(), stateIsValid(), stateLogicalToDisplay(), stateLogicalToOdbc(), stateNormalize(), stateSet()
property text as %String (MAXLEN = 1000000, XMLNAME = "text", XMLPROJECTION = "ATTRIBUTE");
string

Text representation of the address.

Property methods: textDisplayToLogical(), textGet(), textIsValid(), textLogicalToDisplay(), textLogicalToOdbc(), textNormalize(), textSet()
property type as %String (MAXLEN = 1000000, XMLNAME = "type", XMLPROJECTION = "ATTRIBUTE");
code

postal | physical | both

address-type|4.0.1 is the REQUIRED FHIR4 ValueSet for codes; you may NOT extend address-type|4.0.1 and you may NOT use codes from other ValueSets.

Property methods: typeDisplayToLogical(), typeGet(), typeIsValid(), typeLogicalToDisplay(), typeLogicalToOdbc(), typeNormalize(), typeSet()
property use as %String (MAXLEN = 1000000, XMLNAME = "use", XMLPROJECTION = "ATTRIBUTE");
code

home | work | temp | old | billing - purpose of this address

address-use|4.0.1 is the REQUIRED FHIR4 ValueSet for codes; you may NOT extend address-use|4.0.1 and you may NOT use codes from other ValueSets.

Property methods: useDisplayToLogical(), useGet(), useIsValid(), useLogicalToDisplay(), useLogicalToOdbc(), useNormalize(), useSet()

Inherited Members

Inherited Properties

Inherited Methods

FeedbackOpens in a new tab