Skip to main content

HS.SDA3.Guarantor

serial class HS.SDA3.Guarantor extends HS.SDA3.SuperClass

Guarantor appears on three places in the SDA: first, as a list property of
HS.SDA3.Encounter. Guarantor also appears as a property
of HS.SDA3.MemberEnrollment. Both of these are supported and may be used.
It also appears as a list property of HS.SDA3.Container;
however, this property is only present for historical reasons and
should not be used.

Note that while this class does contain HL7 annotations, Guarantor is not
parsed from HL7. The annotations are left in for historical reasons. The
HealthShare HL7 Annotations do not contain the annotations from this class.

Guarantor is not loaded into the Viewer Cache.

Property Inventory

Properties

property ActionScope as %String;
Not used.
Property methods: ActionScopeDisplayToLogical(), ActionScopeGet(), ActionScopeIsValid(), ActionScopeLogicalToDisplay(), ActionScopeLogicalToOdbc(), ActionScopeNormalize(), ActionScopeSet()
property Address as HS.SDA3.Address;
HL7: GT1-5 : GuarantorAddress
VIEWERLIB: Not stored

.Street
HL7: GT1-5.1.1 : StreetAddressStreetorMailingAddress
HL7: GT1-5.2 : OtherDesignation
.City
HL7: GT1-5.3 : City
.State
HL7: GT1-5.4 : StateorProvince
.Zip
HL7: GT1-5.5 : ZiporPostalCode
.Country
HL7: GT1-5.6 : Country
.County
HL7: GT1-5.9 : CountyParishCode
.StartDate
HL7: GT1-5.13.1 : EffectiveDateTime
.EndDate
HL7: GT1-5.14.1 : ExpirationDateTime
Property methods: AddressGet(), AddressGetObject(), AddressGetObjectId(), AddressGetSwizzled(), AddressIsEmpty(), AddressIsValid(), AddressNewObject(), AddressSet(), AddressSetObject(), AddressSetObjectId(), AddressUnSwizzle()
property BirthTime as HS.SDA3.TimeStamp;
Date and time of birth of the guarantor

HL7: GT1-8.1 : GuarantorDateTimeOfBirth.Time
VIEWERLIB: Not stored
Property methods: BirthTimeDisplayToLogical(), BirthTimeGet(), BirthTimeIsValid(), BirthTimeLogicalToDisplay(), BirthTimeLogicalToTimeStamp(), BirthTimeLogicalToXSD(), BirthTimeNormalize(), BirthTimeOdbcToLogical(), BirthTimeSet(), BirthTimeXSDToLogical()
property ContactInfo as HS.SDA3.ContactInfo;
Contact information for the Guarantor

HL7: GT1-6 : GuarantorPhNumHome
HL7: GT1-7 : GuarantorPhNumBusiness
VIEWERLIB: Not stored

.HomePhoneNumber
HL7: GT1-6 : GuarantorPhNumHome
.WorkPhoneNumber
HL7: GT1-7 : GuarantorPhNumBusiness
.MobilePhoneNumber
HL7: GT1-6 : GuarantorPhNumHome
HL7: GT1-7 : GuarantorPhNumBusiness
.EmailAddress
HL7: GT1-6 : GuarantorPhNumHome
HL7: GT1-7 : GuarantorPhNumBusiness
Property methods: ContactInfoGet(), ContactInfoGetObject(), ContactInfoGetObjectId(), ContactInfoGetSwizzled(), ContactInfoIsEmpty(), ContactInfoIsValid(), ContactInfoNewObject(), ContactInfoSet(), ContactInfoSetObject(), ContactInfoSetObjectId(), ContactInfoUnSwizzle()
property EmployerAddress as HS.SDA3.Address;
HL7: GT1-17 : GuarantorEmployerAddress
VIEWERLIB: Not stored

.Street
HL7: GT1-17.1.1 : StreetAddressStreetorMailingAddress
HL7: GT1-17.2 : OtherDesignation
.City
HL7: GT1-17.3 : City
.State
HL7: GT1-17.4 : StateorProvince
.Zip
HL7: GT1-17.5 : ZiporPostalCode
.Country
HL7: GT1-17.6 : Country
.County
HL7: GT1-17.9 : CountyParishCode
.StartDate
HL7: GT1-17.13.1 : EffectiveDateTime
.EndDate
HL7: GT1-17.14.1 : ExpirationDateTime
Property methods: EmployerAddressGet(), EmployerAddressGetObject(), EmployerAddressGetObjectId(), EmployerAddressGetSwizzled(), EmployerAddressIsEmpty(), EmployerAddressIsValid(), EmployerAddressNewObject(), EmployerAddressSet(), EmployerAddressSetObject(), EmployerAddressSetObjectId(), EmployerAddressUnSwizzle()
property EmployerID as %String (MAXLEN = 220);
The guarantor's employer's ID number

HL7: GT1-29.1 : GuarantorEmployerID.IDNumber
VIEWERLIB: Not stored
Property methods: EmployerIDDisplayToLogical(), EmployerIDGet(), EmployerIDIsValid(), EmployerIDLogicalToDisplay(), EmployerIDLogicalToOdbc(), EmployerIDNormalize(), EmployerIDSet()
property EmployerName as HS.SDA3.Name;
The name of the guarantor's employer, if the employer is a person

HL7: GT1-16 : GuarantorEmployerName
VIEWERLIB: Not stored
Property methods: EmployerNameGet(), EmployerNameGetObject(), EmployerNameGetObjectId(), EmployerNameGetSwizzled(), EmployerNameIsEmpty(), EmployerNameIsValid(), EmployerNameNewObject(), EmployerNameSet(), EmployerNameSetObject(), EmployerNameSetObjectId(), EmployerNameUnSwizzle()
property EmployerOrganizationName as %String (MAXLEN = 300);
The name of the guarantor's employer, if the employer is an organization

HL7: GT1-51 : GuarantorEmployerOrganizationName
VIEWERLIB: Not stored
Property methods: EmployerOrganizationNameDisplayToLogical(), EmployerOrganizationNameGet(), EmployerOrganizationNameIsValid(), EmployerOrganizationNameLogicalToDisplay(), EmployerOrganizationNameLogicalToOdbc(), EmployerOrganizationNameNormalize(), EmployerOrganizationNameSet()
property EmployerPhoneNumber as %String (MAXLEN = 60);
HL7: GT1-18 : GuarantorEmployerPhoneNumber
VIEWERLIB: Not stored
Property methods: EmployerPhoneNumberDisplayToLogical(), EmployerPhoneNumberGet(), EmployerPhoneNumberIsValid(), EmployerPhoneNumberLogicalToDisplay(), EmployerPhoneNumberLogicalToOdbc(), EmployerPhoneNumberNormalize(), EmployerPhoneNumberSet()
property EmploymentStatusCode as HS.SDA3.CodeTableDetail.EmploymentStatusCode;
HL7: GT1-20 : GuarantorEmploymentStatusCode
VIEWERLIB: Not stored
Property methods: EmploymentStatusCodeGet(), EmploymentStatusCodeGetObject(), EmploymentStatusCodeGetObjectId(), EmploymentStatusCodeGetSwizzled(), EmploymentStatusCodeIsEmpty(), EmploymentStatusCodeIsValid(), EmploymentStatusCodeNewObject(), EmploymentStatusCodeSet(), EmploymentStatusCodeSetObject(), EmploymentStatusCodeSetObjectId(), EmploymentStatusCodeUnSwizzle()
property EmploymentStopDate as HS.SDA3.TimeStamp;
The date when the guarantor's employment ended

HL7: GT1-32 : GuarantorEmploymentStopDate
VIEWERLIB: Not stored
Property methods: EmploymentStopDateDisplayToLogical(), EmploymentStopDateGet(), EmploymentStopDateIsValid(), EmploymentStopDateLogicalToDisplay(), EmploymentStopDateLogicalToTimeStamp(), EmploymentStopDateLogicalToXSD(), EmploymentStopDateNormalize(), EmploymentStopDateOdbcToLogical(), EmploymentStopDateSet(), EmploymentStopDateXSDToLogical()
property Extension as HS.Local.SDA3.GuarantorExtension;
Property methods: ExtensionGet(), ExtensionGetObject(), ExtensionGetObjectId(), ExtensionGetSwizzled(), ExtensionIsEmpty(), ExtensionIsValid(), ExtensionNewObject(), ExtensionSet(), ExtensionSetObject(), ExtensionSetObjectId(), ExtensionUnSwizzle()
property FromTime as HS.SDA3.TimeStamp;
Effective start date for this guarantor

HL7: GT1-13 : GuarantorDateBegin
VIEWERLIB: Not stored
Property methods: FromTimeDisplayToLogical(), FromTimeGet(), FromTimeIsValid(), FromTimeLogicalToDisplay(), FromTimeLogicalToTimeStamp(), FromTimeLogicalToXSD(), FromTimeNormalize(), FromTimeOdbcToLogical(), FromTimeSet(), FromTimeXSDToLogical()
property Gender as HS.SDA3.CodeTableDetail.Gender;
HL7ToSDA3:
Though GT1-9 is not a coded element type of field, HL7ToSDA3 still only
parses the first piece with respect to the Component Separator. This is
parsed to the to the Gender Code. HL7ToSDA3 does not set the Description.

HL7: GT1-9 : GuarantorAdministrativeSex
VIEWERLIB: Not stored
Property methods: GenderGet(), GenderGetObject(), GenderGetObjectId(), GenderGetSwizzled(), GenderIsEmpty(), GenderIsValid(), GenderNewObject(), GenderSet(), GenderSetObject(), GenderSetObjectId(), GenderUnSwizzle()
property GuarantorNumber as HS.SDA3.PatientNumber;
HL7: GT1-2 : GuarantorNumber
VIEWERLIB: Not stored

.Number
HL7: GT1-2.1 : IDNumber
.Organization
The Assigning Authority for the number
SDATableName=Organization, ViewerClass=User.HS.CTHospital
HL7: GT1-2.4.1 : AssigningAuthorityNamespaceID
HL7: MSH-4 : SendingFacility
.NumberType
HL7: GT1-2.5 : IdentifierTypeCode
Property methods: GuarantorNumberGet(), GuarantorNumberGetObject(), GuarantorNumberGetObjectId(), GuarantorNumberGetSwizzled(), GuarantorNumberIsEmpty(), GuarantorNumberIsValid(), GuarantorNumberNewObject(), GuarantorNumberSet(), GuarantorNumberSetObject(), GuarantorNumberSetObjectId(), GuarantorNumberUnSwizzle()
property GuarantorType as %String (MAXLEN = 32000);
Employer, Self, Family, Friend, etc.

HL7: GT1-10 : GuarantorType
VIEWERLIB: Not stored
Property methods: GuarantorTypeDisplayToLogical(), GuarantorTypeGet(), GuarantorTypeIsValid(), GuarantorTypeLogicalToDisplay(), GuarantorTypeLogicalToOdbc(), GuarantorTypeNormalize(), GuarantorTypeSet()
property HireEffectiveDate as HS.SDA3.TimeStamp;
The date when the guarantor was hired

HL7: GT1-31 : GuarantorHireEffectiveDate
VIEWERLIB: Not stored
Property methods: HireEffectiveDateDisplayToLogical(), HireEffectiveDateGet(), HireEffectiveDateIsValid(), HireEffectiveDateLogicalToDisplay(), HireEffectiveDateLogicalToTimeStamp(), HireEffectiveDateLogicalToXSD(), HireEffectiveDateNormalize(), HireEffectiveDateOdbcToLogical(), HireEffectiveDateSet(), HireEffectiveDateXSDToLogical()
property JobTitle as %String;
The guarantor's job title

HL7: GT1-49 : GuarantorJobTitle
VIEWERLIB: Not stored
Property methods: JobTitleDisplayToLogical(), JobTitleGet(), JobTitleIsValid(), JobTitleLogicalToDisplay(), JobTitleLogicalToOdbc(), JobTitleNormalize(), JobTitleSet()
property Name as HS.SDA3.Name;
Primary name for this person (e.g. legal name)

HL7: GT1-3 : GuarantorName
VIEWERLIB: Not stored

.FamilyName
HL7: GT1-3.1.1 : FamilyNameSurname
.FamilyNamePrefix
HL7: GT1-3.1.2 : FamilyNameOwnSurnamePrefix
.GivenName
HL7: GT1-3.2 : GivenName
.MiddleName
HL7: GT1-3.3 : SecondandFurtherGivenNames
.NameSuffix
HL7: GT1-3.4 : Suffix
.NamePrefix
HL7: GT1-3.5 : Prefix
.ProfessionalSuffix
HL7: GT1-3.14 : ProfessionalSuffix
Property methods: NameGet(), NameGetObject(), NameGetObjectId(), NameGetSwizzled(), NameIsEmpty(), NameIsValid(), NameNewObject(), NameSet(), NameSetObject(), NameSetObjectId(), NameUnSwizzle()
property Occupation as HS.SDA3.CodeTableDetail.Occupation;
The guarantor's occupation

HL7: GT1-50 : GuarantorOccupation
VIEWERLIB: Not stored
Property methods: OccupationGet(), OccupationGetObject(), OccupationGetObjectId(), OccupationGetSwizzled(), OccupationIsEmpty(), OccupationIsValid(), OccupationNewObject(), OccupationSet(), OccupationSetObject(), OccupationSetObjectId(), OccupationUnSwizzle()
property Relationship as HS.SDA3.CodeTableDetail.Relationship;
Relationship code of the guarantor

HL7: GT1-11 : GuarantorRelationship
SDATableName=Relationship, ViewerClass=None
VIEWERLIB: Not stored
Property methods: RelationshipGet(), RelationshipGetObject(), RelationshipGetObjectId(), RelationshipGetSwizzled(), RelationshipIsEmpty(), RelationshipIsValid(), RelationshipNewObject(), RelationshipSet(), RelationshipSetObject(), RelationshipSetObjectId(), RelationshipUnSwizzle()
property SSN as %String (MAXLEN = 220);
HL7: GT1-12 : GuarantorSSN
VIEWERLIB: Not stored
Property methods: SSNDisplayToLogical(), SSNGet(), SSNIsValid(), SSNLogicalToDisplay(), SSNLogicalToOdbc(), SSNNormalize(), SSNSet()
property ToTime as HS.SDA3.TimeStamp;
Effective end date for this guarantor

HL7: GT1-14 : GuarantorDateEnd
VIEWERLIB: Not stored
Property methods: ToTimeDisplayToLogical(), ToTimeGet(), ToTimeIsValid(), ToTimeLogicalToDisplay(), ToTimeLogicalToTimeStamp(), ToTimeLogicalToXSD(), ToTimeNormalize(), ToTimeOdbcToLogical(), ToTimeSet(), ToTimeXSDToLogical()

Inherited Members

Inherited Properties

Inherited Methods

FeedbackOpens in a new tab