Skip to main content


serial class HS.Types.Telecom extends %Library.SerialObject, %XML.Adaptor, %JSON.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 Email as %String (MAXLEN = 500);
Property methods: EmailDisplayToLogical(), EmailGet(), EmailIsValid(), EmailLogicalToDisplay(), EmailLogicalToOdbc(), EmailNormalize(), EmailSet()
property EmailType as %String (MAXLEN = 64);
Possible values in HS_Codes.EmailType table.
Property methods: EmailTypeDisplayToLogical(), EmailTypeGet(), EmailTypeIsValid(), EmailTypeLogicalToDisplay(), EmailTypeLogicalToOdbc(), EmailTypeNormalize(), EmailTypeSet()
property PhoneAreaCode as %String (MAXLEN = 64);
Property methods: PhoneAreaCodeDisplayToLogical(), PhoneAreaCodeGet(), PhoneAreaCodeIsValid(), PhoneAreaCodeLogicalToDisplay(), PhoneAreaCodeLogicalToOdbc(), PhoneAreaCodeNormalize(), PhoneAreaCodeSet()
property PhoneCountryCode as %String (MAXLEN = 64);
Property methods: PhoneCountryCodeDisplayToLogical(), PhoneCountryCodeGet(), PhoneCountryCodeIsValid(), PhoneCountryCodeLogicalToDisplay(), PhoneCountryCodeLogicalToOdbc(), PhoneCountryCodeNormalize(), PhoneCountryCodeSet()
property PhoneNumber as %String (MAXLEN = 64);
Property methods: PhoneNumberDisplayToLogical(), PhoneNumberGet(), PhoneNumberIsValid(), PhoneNumberLogicalToDisplay(), PhoneNumberLogicalToOdbc(), PhoneNumberNormalize(), PhoneNumberSet()
property PhoneNumberFull as %String;
Property methods: PhoneNumberFullCompute(), PhoneNumberFullDisplayToLogical(), PhoneNumberFullGet(), PhoneNumberFullIsValid(), PhoneNumberFullLogicalToDisplay(), PhoneNumberFullLogicalToOdbc(), PhoneNumberFullNormalize(), PhoneNumberFullSQLCompute(), PhoneNumberFullSet(), PhoneNumberFullSetT()
property PrimaryFlag as %Boolean;
Whether the provided email is the primary one
Property methods: PrimaryFlagDisplayToLogical(), PrimaryFlagGet(), PrimaryFlagIsValid(), PrimaryFlagLogicalToDisplay(), PrimaryFlagLogicalToXSD(), PrimaryFlagNormalize(), PrimaryFlagSet(), PrimaryFlagXSDToLogical()
property Status as %String (DISPLAYLIST = ",Active,Inactive", VALUELIST = ",A,I");
Property methods: StatusDisplayToLogical(), StatusGet(), StatusIsValid(), StatusLogicalToDisplay(), StatusLogicalToOdbc(), StatusNormalize(), StatusSet()
property Type as %String (DISPLAYLIST = ",Fax,Pager,Land,Mobile,Other", VALUELIST = ",F,P,L,M,O");
Used to specify what kind of telecom this is: Fax, Pager, Land, or Mobile Do not export to JSON by default
Property methods: TypeDisplayToLogical(), TypeGet(), TypeIsValid(), TypeLogicalToDisplay(), TypeLogicalToOdbc(), TypeNormalize(), TypeSet()
property URL as %String);
Property methods: URLDisplayToLogical(), URLGet(), URLIsValid(), URLLogicalToDisplay(), URLLogicalToOdbc(), URLNormalize(), URLSet()
property Use as %String (DISPLAYLIST = ",Answering Service,Bad,Direct,Emergency Contact,Home,Primary Home,Vacation Home,Mobile Contact,Pager,Public,Temporary,Work Place,", VALUELIST = ",AS,BAD,DIR,EC,H,HP,HV,MC,PG,PUB,TMP,WP,");
Used to specify how this telecom will be used: Primary Home, Vacation Home, Work Place, etc... 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