HealthShare Health Connect 2020.1Opens in a new window > Class Reference > HSLIB namespace > HS.Types.PersonInfo

HS.Types.PersonInfo

class HS.Types.PersonInfo extends %Library.RegisteredObject, %XML.Adaptor

Basic information about a person

Property Inventory

Parameters

parameter XMLIGNOREINVALIDTAG = 1;
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.

Properties

property Addresses as list of HS.Types.Address (STORAGEDEFAULT = "list");
Main address also listed above, for backwards compatability
Property methods: AddressesBuildValueArray(), AddressesCollectionToDisplay(), AddressesCollectionToOdbc(), AddressesDisplayToCollection(), AddressesGet(), AddressesGetObject(), AddressesGetObjectId(), AddressesGetSwizzled(), AddressesIsValid(), AddressesOdbcToCollection(), AddressesSet(), AddressesSetObject(), AddressesSetObjectId()
property BirthOrder as HS.Types.Numeric;
Birth order, if in a multiple birth, else 0, or NULL if unknown
Property methods: BirthOrderDisplayToLogical(), BirthOrderGet(), BirthOrderIsValid(), BirthOrderLogicalToDisplay(), BirthOrderNormalize(), BirthOrderSet(), BirthOrderXSDToLogical()
property BirthPlace as HS.Types.Address;
Property methods: BirthPlaceGet(), BirthPlaceGetObject(), BirthPlaceGetObjectId(), BirthPlaceGetSwizzled(), BirthPlaceIsEmpty(), BirthPlaceIsValid(), BirthPlaceNewObject(), BirthPlaceSet(), BirthPlaceSetObject(), BirthPlaceSetObjectId(), BirthPlaceUnSwizzle()
property BusinessPhone as %String;
Person's business telephone number
Property methods: BusinessPhoneDisplayToLogical(), BusinessPhoneGet(), BusinessPhoneIsValid(), BusinessPhoneLogicalToDisplay(), BusinessPhoneLogicalToOdbc(), BusinessPhoneNormalize(), BusinessPhoneSet()
property City as %String (MAXLEN = 64);
Person's city
Property methods: CityDisplayToLogical(), CityGet(), CityIsValid(), CityLogicalToDisplay(), CityLogicalToOdbc(), CityNormalize(), CityOfBirthDisplayToLogical(), CityOfBirthGet(), CityOfBirthIsValid(), CityOfBirthLogicalToDisplay(), CityOfBirthLogicalToOdbc(), CityOfBirthNormalize(), CityOfBirthSet(), CitySet()
property CityOfBirth as %String (MAXLEN = 64);
Person's city of birth
Property methods: CityOfBirthDisplayToLogical(), CityOfBirthGet(), CityOfBirthIsValid(), CityOfBirthLogicalToDisplay(), CityOfBirthLogicalToOdbc(), CityOfBirthNormalize(), CityOfBirthSet()
property CommunicationPreference as %String (VALUELIST = ","""",Email,Phone,Mail");
For MU2
Property methods: CommunicationPreferenceDisplayToLogical(), CommunicationPreferenceGet(), CommunicationPreferenceIsValid(), CommunicationPreferenceLogicalToDisplay(), CommunicationPreferenceLogicalToOdbc(), CommunicationPreferenceNormalize(), CommunicationPreferenceSet()
property CreatedBy as %String (MAXLEN = 200);
Property methods: CreatedByDisplayToLogical(), CreatedByGet(), CreatedByIsValid(), CreatedByLogicalToDisplay(), CreatedByLogicalToOdbc(), CreatedByNormalize(), CreatedBySet()
property CreatedOn as %TimeStamp;
Property methods: CreatedOnDisplayToLogical(), CreatedOnGet(), CreatedOnIsValid(), CreatedOnLogicalToDisplay(), CreatedOnLogicalToXSD(), CreatedOnNormalize(), CreatedOnOdbcToLogical(), CreatedOnSet(), CreatedOnXSDToLogical()
property DOB as HS.Types.Date (FORMAT = 3);
Person's date-of-birth
Property methods: DOBDisplayToLogical(), DOBGet(), DOBIsValid(), DOBLogicalToDisplay(), DOBLogicalToOdbc(), DOBLogicalToXSD(), DOBNormalize(), DOBOdbcToLogical(), DOBSet(), DOBXSDToLogical()
property DeathStatus as HS.Types.Boolean;
Property methods: DeathStatusDisplayToLogical(), DeathStatusGet(), DeathStatusIsValid(), DeathStatusIsValidDT(), DeathStatusLogicalToDisplay(), DeathStatusLogicalToXSD(), DeathStatusNormalize(), DeathStatusSet(), DeathStatusXSDToLogical()
property DeathTime as HS.Types.TimeStamp;
Time of death
Must be an SDA timestamp to allow the delete instruction (two double quotes) to be passed to the Registry.
Property methods: DeathTimeDisplayToLogical(), DeathTimeGet(), DeathTimeIsValid(), DeathTimeLogicalToDisplay(), DeathTimeLogicalToTimeStamp(), DeathTimeLogicalToXSD(), DeathTimeNormalize(), DeathTimeOdbcToLogical(), DeathTimeSet(), DeathTimeXSDToLogical()
property DriversLicenseNumber as %String (MAXLEN = 64);
Drivers' license number
Property methods: DriversLicenseNumberDisplayToLogical(), DriversLicenseNumberGet(), DriversLicenseNumberIsValid(), DriversLicenseNumberLogicalToDisplay(), DriversLicenseNumberLogicalToOdbc(), DriversLicenseNumberNormalize(), DriversLicenseNumberSet()
property EthnicGroup as %String;
Property methods: EthnicGroupDisplayToLogical(), EthnicGroupGet(), EthnicGroupIsValid(), EthnicGroupLogicalToDisplay(), EthnicGroupLogicalToOdbc(), EthnicGroupNormalize(), EthnicGroupSet()
property FathersName as HS.Types.PersonName;
Property methods: FathersNameGet(), FathersNameGetObject(), FathersNameGetObjectId(), FathersNameGetSwizzled(), FathersNameIsEmpty(), FathersNameIsValid(), FathersNameNewObject(), FathersNameSet(), FathersNameSetObject(), FathersNameSetObjectId(), FathersNameUnSwizzle()
property FirstName as %String (MAXLEN = 60);
Person's firstname
Property methods: FirstNameDisplayToLogical(), FirstNameGet(), FirstNameIsValid(), FirstNameLogicalToDisplay(), FirstNameLogicalToOdbc(), FirstNameNormalize(), FirstNameSet()
property Language as %String;
Property methods: LanguageDisplayToLogical(), LanguageGet(), LanguageIsValid(), LanguageLogicalToDisplay(), LanguageLogicalToOdbc(), LanguageNormalize(), LanguageSet()
property LastEnteredBy as %String (MAXLEN = 200);
Property methods: LastEnteredByDisplayToLogical(), LastEnteredByGet(), LastEnteredByIsValid(), LastEnteredByLogicalToDisplay(), LastEnteredByLogicalToOdbc(), LastEnteredByNormalize(), LastEnteredBySet()
property LastEnteredOn as %TimeStamp;
Property methods: LastEnteredOnDisplayToLogical(), LastEnteredOnGet(), LastEnteredOnIsValid(), LastEnteredOnLogicalToDisplay(), LastEnteredOnLogicalToXSD(), LastEnteredOnNormalize(), LastEnteredOnOdbcToLogical(), LastEnteredOnSet(), LastEnteredOnXSDToLogical()
property LastName as %String (MAXLEN = 80);
Person's lastname
Property methods: LastNameDisplayToLogical(), LastNameGet(), LastNameIsValid(), LastNameLogicalToDisplay(), LastNameLogicalToOdbc(), LastNameNormalize(), LastNameSet()
property MaritalStatus as %String;
Property methods: MaritalStatusDisplayToLogical(), MaritalStatusGet(), MaritalStatusIsValid(), MaritalStatusLogicalToDisplay(), MaritalStatusLogicalToOdbc(), MaritalStatusNormalize(), MaritalStatusSet()
property MiddleName as %String (MAXLEN = 220);
Person's middlename
Property methods: MiddleNameDisplayToLogical(), MiddleNameGet(), MiddleNameIsValid(), MiddleNameLogicalToDisplay(), MiddleNameLogicalToOdbc(), MiddleNameNormalize(), MiddleNameSet()
property MothersMaidenSurname as %String (MAXLEN = 80);
Mothers Maiden Surname
Property methods: MothersMaidenSurnameDisplayToLogical(), MothersMaidenSurnameGet(), MothersMaidenSurnameIsValid(), MothersMaidenSurnameLogicalToDisplay(), MothersMaidenSurnameLogicalToOdbc(), MothersMaidenSurnameNormalize(), MothersMaidenSurnameSet()
property MothersName as HS.Types.PersonName;
Property methods: MothersNameGet(), MothersNameGetObject(), MothersNameGetObjectId(), MothersNameGetSwizzled(), MothersNameIsEmpty(), MothersNameIsValid(), MothersNameNewObject(), MothersNameSet(), MothersNameSetObject(), MothersNameSetObjectId(), MothersNameUnSwizzle()
property Names as list of HS.Types.PersonName (STORAGEDEFAULT = "list");
Main name also listed above
Property methods: NamesBuildValueArray(), NamesCollectionToDisplay(), NamesCollectionToOdbc(), NamesDisplayToCollection(), NamesGet(), NamesGetObject(), NamesGetObjectId(), NamesGetSwizzled(), NamesIsValid(), NamesOdbcToCollection(), NamesSet(), NamesSetObject(), NamesSetObjectId()
property Prefix as %String (MAXLEN = 60);
Person's name prefix
Property methods: PrefixDisplayToLogical(), PrefixGet(), PrefixIsValid(), PrefixLogicalToDisplay(), PrefixLogicalToOdbc(), PrefixNormalize(), PrefixSet()
property Race as %String;
Person's race
Property methods: RaceDisplayToLogical(), RaceGet(), RaceIsValid(), RaceLogicalToDisplay(), RaceLogicalToOdbc(), RaceNormalize(), RaceSet()
property ReligiousAffiliation as %String;
Property methods: ReligiousAffiliationDisplayToLogical(), ReligiousAffiliationGet(), ReligiousAffiliationIsValid(), ReligiousAffiliationLogicalToDisplay(), ReligiousAffiliationLogicalToOdbc(), ReligiousAffiliationNormalize(), ReligiousAffiliationSet()
property SSN as %String (MAXLEN = 220);
Person's social security or government id (made long to support hashed SSNs)
Property methods: SSNDisplayToLogical(), SSNGet(), SSNIsValid(), SSNLogicalToDisplay(), SSNLogicalToOdbc(), SSNNormalize(), SSNSet()
property Sex as %String (MAXLEN = 220);
Person gender
Property methods: SexDisplayToLogical(), SexGet(), SexIsValid(), SexLogicalToDisplay(), SexLogicalToOdbc(), SexNormalize(), SexSet()
property SpousesName as HS.Types.PersonName;
Property methods: SpousesNameGet(), SpousesNameGetObject(), SpousesNameGetObjectId(), SpousesNameGetSwizzled(), SpousesNameIsEmpty(), SpousesNameIsValid(), SpousesNameNewObject(), SpousesNameSet(), SpousesNameSetObject(), SpousesNameSetObjectId(), SpousesNameUnSwizzle()
property State as %String (MAXLEN = 64);
Person's state or province
Property methods: StateDisplayToLogical(), StateGet(), StateIsValid(), StateLogicalToDisplay(), StateLogicalToOdbc(), StateNormalize(), StateSet()
property Street as %String (MAXLEN = 128);
Person's street address
Property methods: StreetDisplayToLogical(), StreetGet(), StreetIsValid(), StreetLogicalToDisplay(), StreetLogicalToOdbc(), StreetNormalize(), StreetSet()
property Suffix as %String (MAXLEN = 60);
Person's name suffix
Property methods: SuffixDisplayToLogical(), SuffixGet(), SuffixIsValid(), SuffixLogicalToDisplay(), SuffixLogicalToOdbc(), SuffixNormalize(), SuffixSet()
property Telecoms as list of HS.Types.Telecom (STORAGEDEFAULT = "list");
Home and work phone also listed above, for backwards compatability
Property methods: TelecomsBuildValueArray(), TelecomsCollectionToDisplay(), TelecomsCollectionToOdbc(), TelecomsDisplayToCollection(), TelecomsGet(), TelecomsGetObject(), TelecomsGetObjectId(), TelecomsGetSwizzled(), TelecomsIsValid(), TelecomsOdbcToCollection(), TelecomsSet(), TelecomsSetObject(), TelecomsSetObjectId()
property Telephone as %String;
Person's home telephone number
Property methods: TelephoneDisplayToLogical(), TelephoneGet(), TelephoneIsValid(), TelephoneLogicalToDisplay(), TelephoneLogicalToOdbc(), TelephoneNormalize(), TelephoneSet()
property VIP as HS.Types.Boolean;
Property methods: VIPDisplayToLogical(), VIPGet(), VIPIsValid(), VIPIsValidDT(), VIPLogicalToDisplay(), VIPLogicalToXSD(), VIPNormalize(), VIPSet(), VIPXSDToLogical()
property Zip as %String (MAXLEN = 16);
Person's postal code
Property methods: ZipDisplayToLogical(), ZipGet(), ZipIsValid(), ZipLogicalToDisplay(), ZipLogicalToOdbc(), ZipNormalize(), ZipSet()

Inherited Members

Inherited Methods

Subclasses

FeedbackOpens in a new window