Skip to main content

HS.SDA3.SocialHistory

serial class HS.SDA3.SocialHistory extends HS.SDA3.SuperClass

HS.SDA3.SocialHistory corresponds to the CDA Social 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 EnteredAt as HS.SDA3.CodeTableDetail.Organization;
SDATableName=Organization, ViewerClass=User.HS.CTHospital
VIEWERLIB: User.HS.PASocHist(SCHUpdateHospitalDR)
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.PASocHist(SCHUpdateUserDR)
Property methods: EnteredByGet(), EnteredByGetObject(), EnteredByGetObjectId(), EnteredByGetSwizzled(), EnteredByIsEmpty(), EnteredByIsValid(), EnteredByNewObject(), EnteredBySet(), EnteredBySetObject(), EnteredBySetObjectId(), EnteredByUnSwizzle()
property EnteredOn as HS.SDA3.TimeStamp;
VIEWERLIB: User.HS.PASocHist(SCHUpdateDate) + User.HS.PASocHist(SCHUpdateTime)
Property methods: EnteredOnDisplayToLogical(), EnteredOnGet(), EnteredOnIsValid(), EnteredOnLogicalToDisplay(), EnteredOnLogicalToTimeStamp(), EnteredOnLogicalToXSD(), EnteredOnNormalize(), EnteredOnOdbcToLogical(), EnteredOnSet(), EnteredOnXSDToLogical()
property Extension as HS.Local.SDA3.SocialHistoryExtension;
Property methods: ExtensionGet(), ExtensionGetObject(), ExtensionGetObjectId(), ExtensionGetSwizzled(), ExtensionIsEmpty(), ExtensionIsValid(), ExtensionNewObject(), ExtensionSet(), ExtensionSetObject(), ExtensionSetObjectId(), ExtensionUnSwizzle()
property ExternalId as %String (MAXLEN = 220);
VIEWERLIB: User.HS.PASocHist(SCHExternalId)
Property methods: ExternalIdDisplayToLogical(), ExternalIdGet(), ExternalIdIsValid(), ExternalIdLogicalToDisplay(), ExternalIdLogicalToOdbc(), ExternalIdNormalize(), ExternalIdSet()
property FromTime as HS.SDA3.TimeStamp;
Beginning of period covered

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

VIEWERLIB: User.HS.PASocHist(SCHOnsetDate)
Property methods: FromTimeDisplayToLogical(), FromTimeGet(), FromTimeIsValid(), FromTimeLogicalToDisplay(), FromTimeLogicalToTimeStamp(), FromTimeLogicalToXSD(), FromTimeNormalize(), FromTimeOdbcToLogical(), FromTimeSet(), FromTimeXSDToLogical()
property SocialHabit as HS.SDA3.CodeTableDetail.SocialHabit;
Social habit code
Ex: "Smoking"

Streamlet cache:
In the OnValidate method of the Streamlet class, if the SDA does not
contain a SocialHabit, and error will be logged and the Streamlet will not
be saved.

SDATableName=SocialHabit, ViewerClass=User.HS.MRCHabits
VIEWERLIB: User.HS.PASocHist(SCHHabitsDR)
Property methods: SocialHabitCategoryGet(), SocialHabitCategoryGetObject(), SocialHabitCategoryGetObjectId(), SocialHabitCategoryGetSwizzled(), SocialHabitCategoryIsEmpty(), SocialHabitCategoryIsValid(), SocialHabitCategoryNewObject(), SocialHabitCategorySet(), SocialHabitCategorySetObject(), SocialHabitCategorySetObjectId(), SocialHabitCategoryUnSwizzle(), SocialHabitCommentsDisplayToLogical(), SocialHabitCommentsGet(), SocialHabitCommentsIsValid(), SocialHabitCommentsLogicalToDisplay(), SocialHabitCommentsLogicalToOdbc(), SocialHabitCommentsNormalize(), SocialHabitCommentsSet(), SocialHabitGet(), SocialHabitGetObject(), SocialHabitGetObjectId(), SocialHabitGetSwizzled(), SocialHabitIsEmpty(), SocialHabitIsValid(), SocialHabitNewObject(), SocialHabitQtyGet(), SocialHabitQtyGetObject(), SocialHabitQtyGetObjectId(), SocialHabitQtyGetSwizzled(), SocialHabitQtyIsEmpty(), SocialHabitQtyIsValid(), SocialHabitQtyNewObject(), SocialHabitQtySet(), SocialHabitQtySetObject(), SocialHabitQtySetObjectId(), SocialHabitQtyUnSwizzle(), SocialHabitSet(), SocialHabitSetObject(), SocialHabitSetObjectId(), SocialHabitUnSwizzle()
property SocialHabitCategory as HS.SDA3.CodeTableDetail.SocialHabitCategory;
Stores coded type of social habit
Property methods: SocialHabitCategoryGet(), SocialHabitCategoryGetObject(), SocialHabitCategoryGetObjectId(), SocialHabitCategoryGetSwizzled(), SocialHabitCategoryIsEmpty(), SocialHabitCategoryIsValid(), SocialHabitCategoryNewObject(), SocialHabitCategorySet(), SocialHabitCategorySetObject(), SocialHabitCategorySetObjectId(), SocialHabitCategoryUnSwizzle()
property SocialHabitComments as %String);
Length subject to the total streamlet size limit - 3,000,000

VIEWERLIB: User.HS.PASocHist(SCHDesc)
Property methods: SocialHabitCommentsDisplayToLogical(), SocialHabitCommentsGet(), SocialHabitCommentsIsValid(), SocialHabitCommentsLogicalToDisplay(), SocialHabitCommentsLogicalToOdbc(), SocialHabitCommentsNormalize(), SocialHabitCommentsSet()
property SocialHabitQty as HS.SDA3.CodeTableDetail.SocialHabitQty;
Quantity associated with social habit
Ex: "Two packs per day"

SDATableName=SocialHabitQty, ViewerClass=User.HS.MRCHabitsQuantity
VIEWERLIB: User.HS.PASocHist(SCHHabitsQtyDR)
Property methods: SocialHabitQtyGet(), SocialHabitQtyGetObject(), SocialHabitQtyGetObjectId(), SocialHabitQtyGetSwizzled(), SocialHabitQtyIsEmpty(), SocialHabitQtyIsValid(), SocialHabitQtyNewObject(), SocialHabitQtySet(), SocialHabitQtySetObject(), SocialHabitQtySetObjectId(), SocialHabitQtyUnSwizzle()
property Status as %String;
Streamlet cache:
In the OnInactivate method of the Streamlet class, if the Status is not
already "I", it is set to "I".
In the OnValidate method, if the Status is null, it is defaulted to "A" for
"Active".

Viewer cache:
A Status of "I" is stored in the viewer cache as "Y". Any other Status is
stored as "N".

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

VIEWERLIB: User.HS.PASocHist(SCHDate) + User.HS.PASocHist(SCHTime)
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