Skip to main content

HS.SDA3.Name

serial class HS.SDA3.Name extends HS.SDA3.DataType

This class holds an extended name, data structure XPN in HL7v2
For example: "Dr. Adam A. J. van Everyman III PhD,VC"
XPN: |Everyman&van^Adam^A. J.^III^Dr.^^^^^^^^^PHD,VC|
FamilyName: Everyman
FamilyNamePrefix: van
NamePrefix: Dr.
NameSuffix: III
GivenName: Adam
MiddleName: A. J.
ProfessionalSuffix: PHD,VC

Property Inventory

Properties

property DOB as HS.SDA3.TimeStamp (XMLIO = "SKIP");
The patient's date of birth, when this Name is used as a patient alias.
This property should not be populated by a data provider. It is copied
here from the Patient BirthTime as records are aggregated at the Access
Gateway so that this Name, as an Alias, can be displayed in the Clinical
Viewer with the DOB of the record from which it originated. This property
is not saved as part of the Patient Streamlet.
Property methods: DOBDisplayToLogical(), DOBGet(), DOBIsValid(), DOBLogicalToDisplay(), DOBLogicalToTimeStamp(), DOBLogicalToXSD(), DOBNormalize(), DOBOdbcToLogical(), DOBSet(), DOBXSDToLogical()
property Extension as HS.Local.SDA3.NameExtension;
Property methods: ExtensionGet(), ExtensionGetObject(), ExtensionGetObjectId(), ExtensionGetSwizzled(), ExtensionIsEmpty(), ExtensionIsValid(), ExtensionNewObject(), ExtensionSet(), ExtensionSetObject(), ExtensionSetObjectId(), ExtensionUnSwizzle()
property FamilyName as %String (MAXLEN = 80);
The main part of the FamilyName, for sorting, etc.
Property methods: FamilyNameDisplayToLogical(), FamilyNameGet(), FamilyNameIsValid(), FamilyNameLogicalToDisplay(), FamilyNameLogicalToOdbc(), FamilyNameNormalize(), FamilyNamePrefixDisplayToLogical(), FamilyNamePrefixGet(), FamilyNamePrefixIsValid(), FamilyNamePrefixLogicalToDisplay(), FamilyNamePrefixLogicalToOdbc(), FamilyNamePrefixNormalize(), FamilyNamePrefixSet(), FamilyNameSet()
property FamilyNamePrefix as %String (MAXLEN = 220);
The prefix for the FamilyName, e.g. "van der"
Property methods: FamilyNamePrefixDisplayToLogical(), FamilyNamePrefixGet(), FamilyNamePrefixIsValid(), FamilyNamePrefixLogicalToDisplay(), FamilyNamePrefixLogicalToOdbc(), FamilyNamePrefixNormalize(), FamilyNamePrefixSet()
property GivenName as %String (MAXLEN = 60);
The (first) given name
Property methods: GivenNameDisplayToLogical(), GivenNameGet(), GivenNameIsValid(), GivenNameLogicalToDisplay(), GivenNameLogicalToOdbc(), GivenNameNormalize(), GivenNameSet()
property MRN as %String (XMLIO = "SKIP");
The patient's medical record number, when this Name is used as a patient
alias. This property should not be populated by a data provider. It is
copied here from the PatientNumber with NumberType="MRN" as records are
aggregated at the Access Gateway so that this Name, as an Alias, can be
displayed in the Clinical Viewer with the MRN of the record from which it
originated. This property is not saved as part of the Patient Streamlet.
Property methods: MRNDisplayToLogical(), MRNGet(), MRNIsValid(), MRNLogicalToDisplay(), MRNLogicalToOdbc(), MRNNormalize(), MRNSet()
property MiddleName as %String (MAXLEN = 220);
The (other) given names or initials
e.g. "John J", "William James", "A. T."
Property methods: MiddleNameDisplayToLogical(), MiddleNameGet(), MiddleNameIsValid(), MiddleNameLogicalToDisplay(), MiddleNameLogicalToOdbc(), MiddleNameNormalize(), MiddleNameSet()
property NamePrefix as %String (MAXLEN = 220);
The prefix for the name, e.g. "Dr."
Property methods: NamePrefixDisplayToLogical(), NamePrefixGet(), NamePrefixIsValid(), NamePrefixLogicalToDisplay(), NamePrefixLogicalToOdbc(), NamePrefixNormalize(), NamePrefixSet()
property NameSuffix as %String (MAXLEN = 220);
The suffix for the name, e.g. "Jr", "III"
Property methods: NameSuffixDisplayToLogical(), NameSuffixGet(), NameSuffixIsValid(), NameSuffixLogicalToDisplay(), NameSuffixLogicalToOdbc(), NameSuffixNormalize(), NameSuffixSet()
property PreferredName as %String (MAXLEN = 220);
The name the person is usually known by other than the first name.
Property methods: PreferredNameDisplayToLogical(), PreferredNameGet(), PreferredNameIsValid(), PreferredNameLogicalToDisplay(), PreferredNameLogicalToOdbc(), PreferredNameNormalize(), PreferredNameSet()
property ProfessionalSuffix as %String (MAXLEN = 220);
The professional credentials, e.g. "MD", "PhD"
Property methods: ProfessionalSuffixDisplayToLogical(), ProfessionalSuffixGet(), ProfessionalSuffixIsValid(), ProfessionalSuffixLogicalToDisplay(), ProfessionalSuffixLogicalToOdbc(), ProfessionalSuffixNormalize(), ProfessionalSuffixSet()
property Type as %String (DISPLAYLIST = ",Alias,Adopted Name,Name At Birth,Display Name,Legal Name,Licensing Name,Maiden Name,Nickname,Previous,Indigenous/Tribal,Unspecified");
Type of name for distinguishing a person's name from his/her birth name VALUELIST taken from EntitynaepartQuaifier of HL7 2.16.840.1.113883.5.43 Same as in HS.Types.PersonName property Type
Property methods: TypeDisplayToLogical(), TypeGet(), TypeIsValid(), TypeLogicalToDisplay(), TypeLogicalToOdbc(), TypeNormalize(), TypeSet()

Inherited Members

Inherited Methods

FeedbackOpens in a new tab