Skip to main content
AskMe (beta)
Loading icon
Responses may be inaccurate. Learn more about AskMe.

HS.SDA3.FamilyHistory

serial class HS.SDA3.FamilyHistory extends HS.SDA3.SuperClass

HS.SDA3.FamilyHistory corresponds to the CDA Family History section.

Property Inventory

Method Inventory

Properties

property ActionCode as %String;
Supported values:
D = Delete
I = Inactivate All (set Status="I")
C = Clear/Delete All
Any other value = Add or Update
See the annotation on the superclass property for more information on how
ActionCode is used.

VIEWERLIB: Not stored
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 Diagnosis as HS.SDA3.CodeTableDetail.Diagnosis;
Diagnosis on family member

SDATableName=Diagnosis, ViewerClass=User.HS.MRCICDDx
VIEWERLIB: User.HS.PAFamily(FAMMRCICDDR)
Property methods: DiagnosisGet(), DiagnosisGetObject(), DiagnosisGetObjectId(), DiagnosisGetSwizzled(), DiagnosisIsEmpty(), DiagnosisIsValid(), DiagnosisNewObject(), DiagnosisSet(), DiagnosisSetObject(), DiagnosisSetObjectId(), DiagnosisUnSwizzle()
property EnteredAt as HS.SDA3.CodeTableDetail.Organization;
SDATableName=Organization, ViewerClass=User.HS.CTHospital
VIEWERLIB: User.HS.PAFamily(FAMUpdateHospitalDR)
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.PAFamily(FAMUpdateUserDR)
Property methods: EnteredByGet(), EnteredByGetObject(), EnteredByGetObjectId(), EnteredByGetSwizzled(), EnteredByIsEmpty(), EnteredByIsValid(), EnteredByNewObject(), EnteredBySet(), EnteredBySetObject(), EnteredBySetObjectId(), EnteredByUnSwizzle()
property EnteredOn as HS.SDA3.TimeStamp;
VIEWERLIB: User.HS.PAFamily(FAMUpdateDate) + User.HS.PAFamily(FAMUpdateTime)
Property methods: EnteredOnDisplayToLogical(), EnteredOnGet(), EnteredOnIsValid(), EnteredOnLogicalToDisplay(), EnteredOnLogicalToTimeStamp(), EnteredOnLogicalToXSD(), EnteredOnNormalize(), EnteredOnOdbcToLogical(), EnteredOnSet(), EnteredOnXSDToLogical()
property Extension as HS.Local.SDA3.FamilyHistoryExtension;
Property methods: ExtensionGet(), ExtensionGetObject(), ExtensionGetObjectId(), ExtensionGetSwizzled(), ExtensionIsEmpty(), ExtensionIsValid(), ExtensionNewObject(), ExtensionSet(), ExtensionSetObject(), ExtensionSetObjectId(), ExtensionUnSwizzle()
property ExternalId as %String (MAXLEN = 220);
Identifier used by systems outside HealthShare

VIEWERLIB: User.HS.PAFamily(FAMExternalId)
Property methods: ExternalIdDisplayToLogical(), ExternalIdGet(), ExternalIdIsValid(), ExternalIdLogicalToDisplay(), ExternalIdLogicalToOdbc(), ExternalIdNormalize(), ExternalIdSet()
property FamilyMember as HS.SDA3.CodeTableDetail.FamilyMember;
Family member covered

Streamlet cache:
In the OnValidate method of the Streamlet class, if no FamilyMember is
defined in the SDA, an error will be logged and the streamlet will not
be saved.

SDATableName=FamilyMember, ViewerClass=User.HS.CTRelation
VIEWERLIB: User.HS.PAFamily(FAMRelationDR)
Property methods: FamilyMemberGet(), FamilyMemberGetObject(), FamilyMemberGetObjectId(), FamilyMemberGetSwizzled(), FamilyMemberIsEmpty(), FamilyMemberIsValid(), FamilyMemberNewObject(), FamilyMemberSet(), FamilyMemberSetObject(), FamilyMemberSetObjectId(), FamilyMemberUnSwizzle()
property FromTime as HS.SDA3.TimeStamp;
Beginning of period covered

Viewer cache:
Only the date part of the FromTime is stored in the Viewer Vache.
(FAMOnsetDate is date-only.)

VIEWERLIB: User.HS.PAFamily(FAMOnsetDate)
Property methods: FromTimeDisplayToLogical(), FromTimeGet(), FromTimeIsValid(), FromTimeLogicalToDisplay(), FromTimeLogicalToTimeStamp(), FromTimeLogicalToXSD(), FromTimeNormalize(), FromTimeOdbcToLogical(), FromTimeSet(), FromTimeXSDToLogical()
property NoteText as %String);
Length subject to the total streamlet size limit - 3,000,000

VIEWERLIB: User.HS.PAFamily(FAMDesc)
Property methods: NoteTextDisplayToLogical(), NoteTextGet(), NoteTextIsValid(), NoteTextLogicalToDisplay(), NoteTextLogicalToOdbc(), NoteTextNormalize(), NoteTextSet()
property Status as %String;
Streamlet cache:
In the OnValidate method of the Streamlet class, if Status is null, it is
defaulted to "A" for "Active".
Deactivating the streamlet via ActionCode="I" will set Status to "I".

Viewer cache:
The stored value will be "Y" if Status is "I", and "N" otherwise.

VIEWERLIB: User.HS.PAFamily(FAMInActive)
Property methods: StatusDisplayToLogical(), StatusGet(), StatusIsValid(), StatusLogicalToDisplay(), StatusLogicalToOdbc(), StatusNormalize(), StatusSet()
property ToTime as HS.SDA3.TimeStamp;
End of period covered

VIEWERLIB: User.HS.PAFamily(FAMDate) + User.HS.PAFamily(FAMTime)
Property methods: ToTimeDisplayToLogical(), ToTimeGet(), ToTimeIsValid(), ToTimeLogicalToDisplay(), ToTimeLogicalToTimeStamp(), ToTimeLogicalToXSD(), ToTimeNormalize(), ToTimeOdbcToLogical(), ToTimeSet(), ToTimeXSDToLogical()

Methods

classmethod EndXMLList()
Inherited description: Utility Method used to when exporting to a container stream or string Subclasses may override if the container property isn't the simple plural (ex: Allergies)
classmethod StartXMLList()
Inherited description: Utility Method used to when exporting to a container stream or string Subclasses may override if the container property isn't the simple plural (ex: Allergies)

Inherited Members

Inherited Properties

Inherited Methods

FeedbackOpens in a new tab