Skip to main content

HS.SDA3.AdvanceDirective

serial class HS.SDA3.AdvanceDirective extends HS.SDA3.SuperClass

HS.SDA3.AdvanceDirective corresponds to the CDA Advance Directives section.

Property Inventory

Properties

property ActionCode as %String;
Supported values:
D = Delete
I = Inactivate All (set Status="I")
C = Clear 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 Alert as HS.SDA3.CodeTableDetail.Alert;
Alert code (e.g. Advanced Directive, Patient Information)

Streamlet cache:
If the AdvanceDirective does not have an Alert, then in the OnValidate
method of the Streamlet class, an error will be logged to the Ensemble
Event Log and the streamlet will not be saved.

SDATableName=Alert, ViewerClass=User.HS.PACPatientAlert
VIEWERLIB: User.HS.PAAlertMsg(ALMAlertDR)
Property methods: AlertGet(), AlertGetObject(), AlertGetObjectId(), AlertGetSwizzled(), AlertIsEmpty(), AlertIsValid(), AlertNewObject(), AlertSet(), AlertSetObject(), AlertSetObjectId(), AlertTypeGet(), AlertTypeGetObject(), AlertTypeGetObjectId(), AlertTypeGetSwizzled(), AlertTypeIsEmpty(), AlertTypeIsValid(), AlertTypeNewObject(), AlertTypeSet(), AlertTypeSetObject(), AlertTypeSetObjectId(), AlertTypeUnSwizzle(), AlertUnSwizzle()
property AlertType as HS.SDA3.CodeTableDetail.AlertType;
Type of alert - can be used for grouping

SDATableName=AlertType, ViewerClass=User.HS.PACAlertCategory
VIEWERLIB: User.HS.PAAlertMsg(ALMAlertCategoryDR)
Property methods: AlertTypeGet(), AlertTypeGetObject(), AlertTypeGetObjectId(), AlertTypeGetSwizzled(), AlertTypeIsEmpty(), AlertTypeIsValid(), AlertTypeNewObject(), AlertTypeSet(), AlertTypeSetObject(), AlertTypeSetObjectId(), AlertTypeUnSwizzle()
property Comments as %String);
Comments on the alert
CRLF-delimited string

VIEWERLIB: User.HS.PAAlertMsg(ALMMessage)
Property methods: CommentsDisplayToLogical(), CommentsGet(), CommentsIsValid(), CommentsLogicalToDisplay(), CommentsLogicalToOdbc(), CommentsNormalize(), CommentsSet()
property EnteredAt as HS.SDA3.CodeTableDetail.Organization;
SDATableName=Organization, ViewerClass=User.HS.CTHospital
VIEWERLIB: User.HS.PAAlertMsg(ALMLastUpdateHospitalDR)
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.PAAlertMsg(ALMCreateUser)
Property methods: EnteredByGet(), EnteredByGetObject(), EnteredByGetObjectId(), EnteredByGetSwizzled(), EnteredByIsEmpty(), EnteredByIsValid(), EnteredByNewObject(), EnteredBySet(), EnteredBySetObject(), EnteredBySetObjectId(), EnteredByUnSwizzle()
property EnteredOn as HS.SDA3.TimeStamp;
VIEWERLIB: User.HS.PAAlertMsg(ALMCreateDate) + User.HS.PAAlertMsg(ALMCreateTime)
Property methods: EnteredOnDisplayToLogical(), EnteredOnGet(), EnteredOnIsValid(), EnteredOnLogicalToDisplay(), EnteredOnLogicalToTimeStamp(), EnteredOnLogicalToXSD(), EnteredOnNormalize(), EnteredOnOdbcToLogical(), EnteredOnSet(), EnteredOnXSDToLogical()
Property methods: ExtensionGet(), ExtensionGetObject(), ExtensionGetObjectId(), ExtensionGetSwizzled(), ExtensionIsEmpty(), ExtensionIsValid(), ExtensionNewObject(), ExtensionSet(), ExtensionSetObject(), ExtensionSetObjectId(), ExtensionUnSwizzle()
property ExternalId as %String (MAXLEN = 220);
VIEWERLIB: User.HS.PAAlertMsg(ALMExternalId)
Property methods: ExternalIdDisplayToLogical(), ExternalIdGet(), ExternalIdIsValid(), ExternalIdLogicalToDisplay(), ExternalIdLogicalToOdbc(), ExternalIdNormalize(), ExternalIdSet()
property FromTime as HS.SDA3.TimeStamp;
Beginning of effective time range

VIEWERLIB: User.HS.PAAlertMsg(ALMOnsetDate) + User.HS.PAAlertMsg(ALMOnsetTime)
Property methods: FromTimeDisplayToLogical(), FromTimeGet(), FromTimeIsValid(), FromTimeLogicalToDisplay(), FromTimeLogicalToTimeStamp(), FromTimeLogicalToXSD(), FromTimeNormalize(), FromTimeOdbcToLogical(), FromTimeSet(), FromTimeXSDToLogical()
property Status as %String;
Alert status
Possible values are "A" for "Active", "I" for "Inactive", and "C" for "To
Be Confirmed".

Streamlet cache:
In the OnBeforeMatch method of the Streamlet class, if the Status is
not "A", "I", or "C" (or null or the delete instruction), it will be
set to null and an alert logged.

Viewer cache:
The value that appears in the viewer does not come from the DISPLAYLIST
of the ALMStatus property, but rather the Description for the corresponding
AlertStatus Standard Type Item. See the HS documentation for guidance on
configuring this.

VIEWERLIB: User.HS.PAAlertMsg(ALMStatus)
Property methods: StatusDisplayToLogical(), StatusGet(), StatusIsValid(), StatusLogicalToDisplay(), StatusLogicalToOdbc(), StatusNormalize(), StatusSet()
property ToTime as HS.SDA3.TimeStamp;
End of effective time range

VIEWERLIB: User.HS.PAAlertMsg(ALMClosedDate) + User.HS.PAAlertMsg(ALMClosedTime)
Property methods: ToTimeDisplayToLogical(), ToTimeGet(), ToTimeIsValid(), ToTimeLogicalToDisplay(), ToTimeLogicalToTimeStamp(), ToTimeLogicalToXSD(), ToTimeNormalize(), ToTimeOdbcToLogical(), ToTimeSet(), ToTimeXSDToLogical()

Inherited Members

Inherited Properties

Inherited Methods

FeedbackOpens in a new tab