Skip to main content


serial class HS.Types.Address extends %Library.SerialObject, %XML.Adaptor, HS.Util.CopyFrom

Property Inventory


Inherited description: The XMLIGNOREINVALIDTAG parameter allows the programmer to control handling of unexpected elements in the XML input. The XMLIGNOREINVALIDTAG parameter will only take affect if XMLSEQUENCE = 0 (the default). By default (XMLIGNOREINVALIDTAG = 0), will treat an unexpected element as an error. If XMLIGNOREINVALIDTAG is set = 1 and XMLSEQUENCE = 0, then unexpected elements will be ignored.
parameter XMLIGNORENULL = inputonly;
Inherited description: XMLIGNORENULL allows the programmer to override the default XML handling of empty strings for properties of type %String. By default (XMLIGNORENULL = 0), empty strings in the XML input are stored as $c(0) and $c(0) is written to XML as an empty tag. A missing tag in the XML input is always stored as "" and "" is always output to XML as no tag.

If XMLIGNORENULL is set = 1, then both missing tags in the XML and empty strings are input as "", and both "" and $c(0) are output as empty tags (i.e. <tag></tag>).

If XMLIGNORENULL is set = "inputonly", then both missing tags in the XML and empty strings are input as "". Output of "" and $c(0) are for XMLIGNORENULL = 0: $c(0) is output as an empty tag (i.e. <tag></tag>) and "" is output as no tag.

If XMLIGNORENULL = "runtime" (runtime is not case sensitive), then the behavior of XMLIGNORENULL is determined by the format parameter of XMLExport, XMLImport and %XML.Reader.OpenFile. The default behavior for XMLIGNORENULL="runtime is the same as XMLIGNORENULL=0. Adding "ignorenull" to the format argument changes the behavior to that of XMLIGNORENULL=1. "ignorenull" shoud be separated by a comma from literal/encoded part of the format. Example values for format are "", ",ignorenull", "literal,ignorenull" and "encoded,ignorenull". Note that "inputonly" is equivalent to using ,ignorenull for XMLExport and not for %XML.Reader.


property City as %String (MAXLEN = 64);
Property methods: CityDisplayToLogical(), CityGet(), CityIsValid(), CityLogicalToDisplay(), CityLogicalToOdbc(), CityNormalize(), CitySet()
property Country as %String (MAXLEN = 64);
Property methods: CountryDisplayToLogical(), CountryGet(), CountryIsValid(), CountryLogicalToDisplay(), CountryLogicalToOdbc(), CountryNormalize(), CountrySet()
property County as %String (MAXLEN = 64);
Property methods: CountyDisplayToLogical(), CountyGet(), CountyIsValid(), CountyLogicalToDisplay(), CountyLogicalToOdbc(), CountyNormalize(), CountySet()
property Description as %String);
Property methods: DescriptionDisplayToLogical(), DescriptionGet(), DescriptionIsValid(), DescriptionLogicalToDisplay(), DescriptionLogicalToOdbc(), DescriptionNormalize(), DescriptionSet()
property POBox as %String;
Property methods: POBoxDisplayToLogical(), POBoxGet(), POBoxIsValid(), POBoxLogicalToDisplay(), POBoxLogicalToOdbc(), POBoxNormalize(), POBoxSet()
property PostalCode as %String (MAXLEN = 64);
Property methods: PostalCodeDisplayToLogical(), PostalCodeGet(), PostalCodeIsValid(), PostalCodeLogicalToDisplay(), PostalCodeLogicalToOdbc(), PostalCodeNormalize(), PostalCodeSet()
property Precinct as %String (MAXLEN = 64);
Property methods: PrecinctDisplayToLogical(), PrecinctGet(), PrecinctIsValid(), PrecinctLogicalToDisplay(), PrecinctLogicalToOdbc(), PrecinctNormalize(), PrecinctSet()
property PrimaryFlag as HS.Types.Boolean;
Property methods: PrimaryFlagDisplayToLogical(), PrimaryFlagGet(), PrimaryFlagIsValid(), PrimaryFlagIsValidDT(), PrimaryFlagLogicalToDisplay(), PrimaryFlagLogicalToXSD(), PrimaryFlagNormalize(), PrimaryFlagSet(), PrimaryFlagXSDToLogical()
property State as %String (MAXLEN = 64);
Property methods: StateDisplayToLogical(), StateGet(), StateIsValid(), StateLogicalToDisplay(), StateLogicalToOdbc(), StateNormalize(), StateSet()
property Status as %String (DISPLAYLIST = ","""",Active,Inactive", VALUELIST = ","""",A,I") [ InitialExpression = "A" ];
Property methods: StatusDisplayToLogical(), StatusGet(), StatusIsValid(), StatusLogicalToDisplay(), StatusLogicalToOdbc(), StatusNormalize(), StatusSet()
property StreetLine as %String);
Property methods: StreetLineDisplayToLogical(), StreetLineGet(), StreetLineIsValid(), StreetLineLogicalToDisplay(), StreetLineLogicalToOdbc(), StreetLineNormalize(), StreetLineSet()
property StreetName as %String);
Property methods: StreetNameCompute(), StreetNameDisplayToLogical(), StreetNameGet(), StreetNameIsValid(), StreetNameLogicalToDisplay(), StreetNameLogicalToOdbc(), StreetNameNormalize(), StreetNameSQLCompute(), StreetNameSet(), StreetNameSetT()
property StreetNumber as %String);
Property methods: StreetNumberCompute(), StreetNumberDisplayToLogical(), StreetNumberGet(), StreetNumberIsValid(), StreetNumberLogicalToDisplay(), StreetNumberLogicalToOdbc(), StreetNumberNormalize(), StreetNumberSQLCompute(), StreetNumberSet(), StreetNumberSetT()
property StreetType as %String);
Property methods: StreetTypeCompute(), StreetTypeDisplayToLogical(), StreetTypeGet(), StreetTypeIsValid(), StreetTypeLogicalToDisplay(), StreetTypeLogicalToOdbc(), StreetTypeNormalize(), StreetTypeSQLCompute(), StreetTypeSet(), StreetTypeSetT()
property UnitNumber as %String;
Property methods: UnitNumberDisplayToLogical(), UnitNumberGet(), UnitNumberIsValid(), UnitNumberLogicalToDisplay(), UnitNumberLogicalToOdbc(), UnitNumberNormalize(), UnitNumberSet()
property Use as %String (DISPLAYLIST = ",Alphabetic,Bad Address,Home,Primary Home,Vacation Home,Ideographic,Visit Address,Postal Address,Syllabic,Temporary Address,Work Place,Billing,Mailing", VALUELIST = ",ABC,BAD,H,HP,HV,IDE,PHYS,PST,SYL,TMP,WP,BIL,ML");
Values taken from HL7v3 TelecommunicationAddressUse Domain (OID: 2.16.840.1.113883.1.11.201) Also see:
Property methods: UseDisplayToLogical(), UseGet(), UseIsValid(), UseLogicalToDisplay(), UseLogicalToOdbc(), UseNormalize(), UseSet()

Inherited Members

Inherited Methods


FeedbackOpens in a new tab