Skip to main content

HS.SDA3.HealthFund

serial class HS.SDA3.HealthFund extends HS.SDA3.SuperClass

HS.SDA3.HealthFund corresponds to the CDA Payers section.

Property Inventory

Properties

property ActionCode as %String;
Not used.
Property methods: ActionCodeDisplayToLogical(), ActionCodeGet(), ActionCodeIsValid(), ActionCodeLogicalToDisplay(), ActionCodeLogicalToOdbc(), ActionCodeNormalize(), ActionCodeSet()
property ActionScope as %String;
Not used.
Property methods: ActionScopeDisplayToLogical(), ActionScopeGet(), ActionScopeIsValid(), ActionScopeLogicalToDisplay(), ActionScopeLogicalToOdbc(), ActionScopeNormalize(), ActionScopeSet()
property EncounterNumber as %String (MAXLEN = 220);
Not used.
Property methods: EncounterNumberDisplayToLogical(), EncounterNumberGet(), EncounterNumberIsValid(), EncounterNumberLogicalToDisplay(), EncounterNumberLogicalToOdbc(), EncounterNumberNormalize(), EncounterNumberSet()
property EnteredAt as HS.SDA3.CodeTableDetail.Organization;
SDATableName=Organization, ViewerClass=User.HS.CTHospital
VIEWERLIB: User.HS.PAAdmInsurance(INSUpdateUserHospitalDR)
Property methods: EnteredAtGet(), EnteredAtGetObject(), EnteredAtGetObjectId(), EnteredAtGetSwizzled(), EnteredAtIsEmpty(), EnteredAtIsValid(), EnteredAtNewObject(), EnteredAtSet(), EnteredAtSetObject(), EnteredAtSetObjectId(), EnteredAtUnSwizzle()
property EnteredBy as HS.SDA3.CodeTableDetail.User;
SDATableName=User, ViewerClass=User.HS.SSUser
VIEWERLIB: User.HS.PAAdmInsurance(INSUpdateUserDR)
Property methods: EnteredByGet(), EnteredByGetObject(), EnteredByGetObjectId(), EnteredByGetSwizzled(), EnteredByIsEmpty(), EnteredByIsValid(), EnteredByNewObject(), EnteredBySet(), EnteredBySetObject(), EnteredBySetObjectId(), EnteredByUnSwizzle()
property EnteredOn as HS.SDA3.TimeStamp;
VIEWERLIB: User.HS.PAAdmInsurance(INSUpdateDate) + User.HS.PAAdmInsurance(INSUpdateTime)
Property methods: EnteredOnDisplayToLogical(), EnteredOnGet(), EnteredOnIsValid(), EnteredOnLogicalToDisplay(), EnteredOnLogicalToTimeStamp(), EnteredOnLogicalToXSD(), EnteredOnNormalize(), EnteredOnOdbcToLogical(), EnteredOnSet(), EnteredOnXSDToLogical()
property Extension as HS.Local.SDA3.HealthFundExtension;
Property methods: ExtensionGet(), ExtensionGetObject(), ExtensionGetObjectId(), ExtensionGetSwizzled(), ExtensionIsEmpty(), ExtensionIsValid(), ExtensionNewObject(), ExtensionSet(), ExtensionSetObject(), ExtensionSetObjectId(), ExtensionUnSwizzle()
property ExternalId as %String (MAXLEN = 220);
Not used.
Property methods: ExternalIdDisplayToLogical(), ExternalIdGet(), ExternalIdIsValid(), ExternalIdLogicalToDisplay(), ExternalIdLogicalToOdbc(), ExternalIdNormalize(), ExternalIdSet()
property FromTime as HS.SDA3.TimeStamp;
Effective date of insurance

Viewer cache:
Only the date part of FromTime is stored in the viewer cache. (Both of the
fields it is stored to are date-only.)

HL7: IN1-12 : PlanEffectiveDate
VIEWERLIB: User.HS.PAAdmInsurance(INSDateTypeFrom)
VIEWERLIB: User.HS.PAAdmInsurance(INSDateValidFrom)
Property methods: FromTimeDisplayToLogical(), FromTimeGet(), FromTimeIsValid(), FromTimeLogicalToDisplay(), FromTimeLogicalToTimeStamp(), FromTimeLogicalToXSD(), FromTimeNormalize(), FromTimeOdbcToLogical(), FromTimeSet(), FromTimeXSDToLogical()
property GroupName as %String (MAXLEN = 32000);
HL7ToSDA3:
Though IN1-9 is a repeating field, HL7ToSDA3 only uses the first instance.

HL7: IN1-9.1 : GroupName.OrganizationName
VIEWERLIB: Not stored
Property methods: GroupNameDisplayToLogical(), GroupNameGet(), GroupNameIsValid(), GroupNameLogicalToDisplay(), GroupNameLogicalToOdbc(), GroupNameNormalize(), GroupNameSet()
property GroupNumber as %String (MAXLEN = 32000);
HL7: IN1-8 : GroupNumber
VIEWERLIB: Not stored
Property methods: GroupNumberDisplayToLogical(), GroupNumberGet(), GroupNumberIsValid(), GroupNumberLogicalToDisplay(), GroupNumberLogicalToOdbc(), GroupNumberNormalize(), GroupNumberSet()
property HealthFund as HS.SDA3.CodeTableDetail.HealthFund;
Code for health fund that provides the insurance

HL7ToSDA3:
If both IN1-3.1 and -4.1 are null, the IN1 segment will not be processed.

SDATableName=HealthFund, ViewerClass=User.HS.ARCInsuranceType
VIEWERLIB: User.HS.PAAdmInsurance(INSInsTypeDR)

.SDACodingStandard
HL7: IN1-3.4 : InsuranceCompanyID.AssigningAuthority
VIEWERLIB: Not stored
.Code
HL7: IN1-3.1 : InsuranceCompanyID.IDNumber
VIEWERLIB: User.HS.ARCInsuranceType(INSTCode)
.Description
HL7: IN1-4.1 : InsuranceCompanyName.OrganizationName
VIEWERLIB: User.HS.ARCInsuranceType(INSTDesc)

.Address
HL7ToSDA3:
Though IN1-5 is a repeating field, HL7ToSDA3 only uses the first instance.
Also, only a Code is parsed for the City, State, Zip, Country, and County
properties. HL7ToSDA3 does not set a Description for these.
HL7: IN1-5 : InsuranceCompanyAddress
VIEWERLIB: Not stored
.Address.Street
HL7ToSDA3:
Street is parsed as: "[IN1-5.1.1]; [IN1-5.2]"
HL7: IN1-5.1.1 : InsuranceCompanyAddress.StreetAddress.StreetorMailingAddress
HL7: IN1-5.2 : InsuranceCompanyAddress.OtherDesignation
.Address.City
HL7: IN1-5.3 : InsuranceCompanyAddress.City
.Address.State
HL7: IN1-5.4 : InsuranceCompanyAddress.StateorProvince
.Address.Zip
HL7: IN1-5.5 : InsuranceCompanyAddress.ZiporPostalCode
.Address.Country
HL7: IN1-5.6 : InsuranceCompanyAddress.Country
.Address.County
HL7: IN1-5.9 : InsuranceCompanyAddress.CountyParishCode
.Address.FromTime
HL7: IN1-5.13.1 : InsuranceCompanyAddress.EffectiveDate.Time
.Address.ToTime
HL7: IN1-5.14.1 : InsuranceCompanyAddress.ExpirationDate.Time
.ContactPerson
HL7: IN1-6 : InsuranceCoContactPerson
VIEWERLIB: Not stored
.ContactPerson.FamilyName
HL7: IN1-6.1.1 : FamilyName.Surname
.ContactPerson.FamilyNamePrefix
HL7: IN1-6.1.2 : FamilyName.OwnSurnamePrefix
.ContactPerson.GivenName
HL7: IN1-6.2 : GivenName
.ContactPerson.MiddleName
HL7: IN1-6.3 : SecondandFurtherGivenNames
.ContactPerson.NameSuffix
HL7: IN1-6.4 : Suffix
.ContactPerson.NamePrefix
HL7: IN1-6.5 : Prefix
.ContactPerson.ProfessionalSuffix
HL7: IN1-6.14 : ProfessionalSuffix

.ContactInfo
HL7ToSDA3:
IN1-7 is a repeating field, and each instance may populate WorkPhoneNumber,
MobilePhoneNumber, or EmailAddress, depending on the values contained
therein. For each instance of IN1-7, the algorithm to parse a phone number
out of that instance is:
-If subfields 5, 6, 7, and 8 are not all null, compose the number out of
them as "+[.5] ([.6]) [.7] x[.8]".
-Else if subfield 12 is not null, use that.
-Else if subfield 1 is not null, use that.
-Else continue to the next instance of this field.

-Whichever number is parsed, if subfield 9 of that instance is not null, it
will be appended to the number, delimited by a semicolon.
Ex: "###-###-####;Main Number"
HL7: IN1-7 : InsuranceCoPhoneNumber
VIEWERLIB: Not stored
.ContactInfo.WorkPhoneNumber
HL7ToSDA3:
WorkPhoneNumber is parsed from the first instance of IN1-7 with subfield 2
in ["",WPN,ASN,EMR], and subfield 3 in ["",PH], and from which a number can
be parsed using the above algorithm.
HL7: IN1-7 : InsuranceCoPhoneNumber
.ContactInfo.MobilePhoneNumber
HL7ToSDA3:
MobilePhoneNumber is parsed from the first instance with subfield 2 = "BPN"
or subfield 3 in [CP,BP], and from which a number can be parsed using the
above algorithm.
HL7: IN1-7 : InsuranceCoPhoneNumber
.ContactInfo.EmailAddress
HL7ToSDA3:
EmailAddress is parsed from the first non-null instance of subfield 4 in
IN1-7.
HL7: IN1-7.4 : InsuranceCoPhoneNumber.EmailAddress
Property methods: HealthFundGet(), HealthFundGetObject(), HealthFundGetObjectId(), HealthFundGetSwizzled(), HealthFundIsEmpty(), HealthFundIsValid(), HealthFundNewObject(), HealthFundPlanGet(), HealthFundPlanGetObject(), HealthFundPlanGetObjectId(), HealthFundPlanGetSwizzled(), HealthFundPlanIsEmpty(), HealthFundPlanIsValid(), HealthFundPlanNewObject(), HealthFundPlanSet(), HealthFundPlanSetObject(), HealthFundPlanSetObjectId(), HealthFundPlanUnSwizzle(), HealthFundSet(), HealthFundSetObject(), HealthFundSetObjectId(), HealthFundUnSwizzle()
property HealthFundPlan as HS.SDA3.CodeTableDetail.HealthFundPlan;
Code for specific insurance plan

HL7ToSDA3:
HealthFundPlan will only be parsed if IN1-2.1 or .2 is not null.

HL7: IN1-2 : InsurancePlanID
SDATableName=HealthFundPlan, ViewerClass=User.HS.ARCAuxilInsurType
VIEWERLIB: User.HS.PAAdmInsurance(INSAuxInsTypeDR)

.Code
HL7: IN1-2.1 : InsurancePlanID.Identifier
VIEWERLIB: User.HS.ARCAuxilInsurType(AUXITCode)
.Description
HL7: IN1-2.2 : InsurancePlanID.Text
VIEWERLIB: User.HS.ARCAuxilInsurType(AUXITDesc)
.SDACodingStandard
HL7: IN1-2.3 : InsurancePlanID.NameofCodingSystem
VIEWERLIB: Not stored
Property methods: HealthFundPlanGet(), HealthFundPlanGetObject(), HealthFundPlanGetObjectId(), HealthFundPlanGetSwizzled(), HealthFundPlanIsEmpty(), HealthFundPlanIsValid(), HealthFundPlanNewObject(), HealthFundPlanSet(), HealthFundPlanSetObject(), HealthFundPlanSetObjectId(), HealthFundPlanUnSwizzle()
property InsuredAddress as HS.SDA3.Address;
Address of insured person

HL7ToSDA3:
Though IN1-19 is a repeating field, HL7ToSDA3 only uses the first instance.
Also, only a Code is parsed for the City, State, Zip, and Country
properties. HL7ToSDA3 does not set a Description for these.

HL7: IN1-19 : InsuredsAddress

.Street
HL7ToSDA3:
Street is parsed as "[IN-19.1.1]; [IN1-19.2]".
HL7: IN1-19.1.1 : InsuredsAddress.StreetAddress.StreetorMailingAddress
HL7: IN1-19.2 : InsuredsAddress.OtherDesignation
VIEWERLIB: User.HS.PAAdmInsurance(INSCardholderAddress)
.City
HL7: IN1-19.3 : InsuredsAddress.City
VIEWERLIB: User.HS.PAAdmInsurance(INSCardholderCityDR)
.State
HL7: IN1-19.4 : InsuredsAddress.StateorProvince
VIEWERLIB: Not stored
.Zip
HL7: IN1-19.5 : InsuredsAddress.ZiporPostalCode
VIEWERLIB: User.HS.PAAdmInsurance(INSCardholderZipDR)
.Country
HL7: IN1-19.6 : InsuredsAddress.Country
VIEWERLIB: Not stored
.County
HL7: IN1-19.9 : InsuredsAddress.CountyParishCode
VIEWERLIB: Not stored
.FromTime
HL7: IN1-19.13.1 : InsuredsAddress.EffectiveDate.Time
VIEWERLIB: Not stored
.ToTime
HL7: IN1-19.14.1 : InsuredsAddress.ExpirationDate.Time
VIEWERLIB: Not stored
Property methods: InsuredAddressGet(), InsuredAddressGetObject(), InsuredAddressGetObjectId(), InsuredAddressGetSwizzled(), InsuredAddressIsEmpty(), InsuredAddressIsValid(), InsuredAddressNewObject(), InsuredAddressSet(), InsuredAddressSetObject(), InsuredAddressSetObjectId(), InsuredAddressUnSwizzle()
property InsuredContact as HS.SDA3.ContactInfo;
Contact information for the Insured person

VIEWERLIB: Not stored
Property methods: InsuredContactGet(), InsuredContactGetObject(), InsuredContactGetObjectId(), InsuredContactGetSwizzled(), InsuredContactIsEmpty(), InsuredContactIsValid(), InsuredContactNewObject(), InsuredContactSet(), InsuredContactSetObject(), InsuredContactSetObjectId(), InsuredContactUnSwizzle()
property InsuredName as HS.SDA3.Name;
The name of the insured person

HL7ToSDA3:
Though IN1-16 is a repeating field, HL7ToSDA3 only uses the first instance.

Viewer cache:
INSCardholderName is a string property that is set as:
"[NamePrefix] [GivenName] [MiddleName] [FamilyName]"
or simply null if all those properties are null.

HL7: IN1-16 : NameOfInsured
VIEWERLIB: User.HS.PAAdmInsurance(INSCardholderName)
.FamilyName
HL7: IN1-16.1.1 : NameOfInsured.FamilyName.Surname
VIEWERLIB: User.HS.PAAdmInsurance(INSCardholderName)
.FamilyNamePrefix
HL7: IN1-16.1.2 : NameOfInsured.FamilyName.OwnSurnamePrefix
VIEWERLIB: Not stored
.GivenName
HL7: IN1-16.2 : NameOfInsured.GivenName
VIEWERLIB: User.HS.PAAdmInsurance(INSCardholderName)
.MiddleName
HL7: IN1-16.3 : NameOfInsured.SecondandFurtherGivenNames
VIEWERLIB: User.HS.PAAdmInsurance(INSCardholderName)
.NameSuffix
HL7: IN1-16.4 : NameOfInsured.Suffix
VIEWERLIB: Not stored
.NamePrefix
HL7: IN1-16.5 : NameOfInsured.Prefix
VIEWERLIB: User.HS.PAAdmInsurance(INSCardholderName)
.ProfessionalSuffix
HL7: IN1-16.14 : NameOfInsured.ProfessionalSuffix
VIEWERLIB: Not stored
Property methods: InsuredNameGet(), InsuredNameGetObject(), InsuredNameGetObjectId(), InsuredNameGetSwizzled(), InsuredNameIsEmpty(), InsuredNameIsValid(), InsuredNameNewObject(), InsuredNameSet(), InsuredNameSetObject(), InsuredNameSetObjectId(), InsuredNameUnSwizzle()
property InsuredRelationship as HS.SDA3.CodeTableDetail.Relationship;
Relationship of insured person to patient

HL7ToSDA3:
IN1-17 will only be parsed if IN1-17.1 or .2 are not null.

HL7: IN1-17 : InsuredsRelationshipToPatient
SDATableName=Relationship, ViewerClass=None
VIEWERLIB: Not stored

.Code
HL7: IN1-17.1 : InsuredsRelationshipToPatient.Identifier
.Description
HL7: IN1-17.2 : InsuredsRelationshipToPatient.Text
.SDACodingStandard
HL7: IN1-17.3 : InsuredsRelationshipToPatient.NameofCodingSystem
Property methods: InsuredRelationshipGet(), InsuredRelationshipGetObject(), InsuredRelationshipGetObjectId(), InsuredRelationshipGetSwizzled(), InsuredRelationshipIsEmpty(), InsuredRelationshipIsValid(), InsuredRelationshipNewObject(), InsuredRelationshipSet(), InsuredRelationshipSetObject(), InsuredRelationshipSetObjectId(), InsuredRelationshipUnSwizzle()
property MembershipNumber as %String (MAXLEN = 220);
Membership Number or Policy Number

HL7: IN1-36 : PolicyNumber
VIEWERLIB: User.HS.PAAdmInsurance(INSCardNo)
Property methods: MembershipNumberDisplayToLogical(), MembershipNumberGet(), MembershipNumberIsValid(), MembershipNumberLogicalToDisplay(), MembershipNumberLogicalToOdbc(), MembershipNumberNormalize(), MembershipNumberSet()
property PayerId as HS.SDA3.Identifier;
Payer ID for the health fund.
Property methods: PayerIdGet(), PayerIdGetObject(), PayerIdGetObjectId(), PayerIdGetSwizzled(), PayerIdIsEmpty(), PayerIdIsValid(), PayerIdNewObject(), PayerIdSet(), PayerIdSetObject(), PayerIdSetObjectId(), PayerIdUnSwizzle()
property PlanType as %String (MAXLEN = 32000);
HL7: IN1-15 : PlanType
VIEWERLIB: Not stored
Property methods: PlanTypeDisplayToLogical(), PlanTypeGet(), PlanTypeIsValid(), PlanTypeLogicalToDisplay(), PlanTypeLogicalToOdbc(), PlanTypeNormalize(), PlanTypeSet()
property Priority as %String;
If the insurance works in conjunction with other insurance plans, this field contains priority sequence. Values are: 1, 2, 3, etc.

HL7: IN1-22 : CoordofBenPriority
VIEWERLIB: Not stored
Property methods: PriorityDisplayToLogical(), PriorityGet(), PriorityIsValid(), PriorityLogicalToDisplay(), PriorityLogicalToOdbc(), PriorityNormalize(), PrioritySet()
property TaxId as HS.SDA3.Identifier;
Tax ID number for the health fund.
Property methods: TaxIdGet(), TaxIdGetObject(), TaxIdGetObjectId(), TaxIdGetSwizzled(), TaxIdIsEmpty(), TaxIdIsValid(), TaxIdNewObject(), TaxIdSet(), TaxIdSetObject(), TaxIdSetObjectId(), TaxIdUnSwizzle()
property ToTime as HS.SDA3.TimeStamp;
Expiration date of insurance

Viewer cache:
Only the date part of ToTime is stored in the viewer cache. (INSDateTypeTo
is date-only.)

HL7: IN1-12 : PlanExpirationDate
VIEWERLIB: User.HS.PAAdmInsurance(INSDateTypeTo)
Property methods: ToTimeDisplayToLogical(), ToTimeGet(), ToTimeIsValid(), ToTimeLogicalToDisplay(), ToTimeLogicalToTimeStamp(), ToTimeLogicalToXSD(), ToTimeNormalize(), ToTimeOdbcToLogical(), ToTimeSet(), ToTimeXSDToLogical()
property UpdatedOn as HS.SDA3.TimeStamp;
Not used.
Property methods: UpdatedOnDisplayToLogical(), UpdatedOnGet(), UpdatedOnIsValid(), UpdatedOnLogicalToDisplay(), UpdatedOnLogicalToTimeStamp(), UpdatedOnLogicalToXSD(), UpdatedOnNormalize(), UpdatedOnOdbcToLogical(), UpdatedOnSet(), UpdatedOnXSDToLogical()

Inherited Members

Inherited Properties

Inherited Methods

FeedbackOpens in a new tab