HS.FHIR.SessionData.FHIRSession

deprecated persistent class HS.FHIR.SessionData.FHIRSession extends HS.Util.SessionData.Session

SQL Table Name: HS_FHIR_SessionData.FHIRSession

THIS CLASS IS DEPRECATED Use HS.FHIRServer.* instead.
Every FHIR resource streamlet (subclass of HS.FHIR.vDSTU2.Repository.Resource.Abstract or HS.FHIR.vSTU3.Repository.Resource.Abstract) stored in the resource repository may optionally be linked to a FHIRSession via its Session property. A linked streamlet will have Session="[FHIRSession.Application]||[FHIRSession.SessionId]".
When the FHIRSession is deleted, the streamlet will also be deleted (physical delete, as opposed to just being marked deleted). This is implemented via the %OnDelete() method and OnDeleteSQL trigger in this class. For this reason, FHIRSessions *must not* be deleted by manually killing nodes in the storage global.

Property Inventory

• Expires
• PatientResourceId
• SessionID
• SessionState
• UserRoles
• Username

Method Inventory

• DeleteAllSessions()
• DeleteDSTU2()
• DeleteExpiredSessions()
• DeleteSTU3()
• IsExpired()
• IsExpiredHandler()
• IsExpiredSQLProc()
• OnDeleteHandler()

Properties

property Expires as %Integer;

Expires is the time in seconds from beginning of the Unix epoch when the session expires. If Expires="", then session does not expire.

Property methods: ExpiresDisplayToLogical(), ExpiresGet(), ExpiresGetStored(), ExpiresIsValid(), ExpiresLogicalToDisplay(), ExpiresNormalize(), ExpiresSet(), ExpiresXSDToLogical()

property PatientResourceId as %String (MAXLEN = 64);

Patient MPIID as the FHIR Patient resource id.

Property methods: PatientResourceIdDisplayToLogical(), PatientResourceIdGet(), PatientResourceIdGetStored(), PatientResourceIdIsValid(), PatientResourceIdLogicalToDisplay(), PatientResourceIdLogicalToOdbc(), PatientResourceIdNormalize(), PatientResourceIdSet()

property SessionID as %String (COLLATION = "EXACT", MAXLEN = 127) [ Required ];

Override of property from inherited class. This value should be set to an application-specific session identifier.

Property methods: SessionIDDisplayToLogical(), SessionIDGet(), SessionIDGetStored(), SessionIDIsValid(), SessionIDLogicalToDisplay(), SessionIDLogicalToOdbc(), SessionIDNormalize(), SessionIDSet()

property SessionState as %Integer [ InitialExpression = 0 ];

Property methods: SessionStateDisplayToLogical(), SessionStateGet(), SessionStateGetStored(), SessionStateIsValid(), SessionStateLogicalToDisplay(), SessionStateNormalize(), SessionStateSet(), SessionStateXSDToLogical()

property UserRoles as %String (MAXLEN = 2048);

Property methods: UserRolesDisplayToLogical(), UserRolesGet(), UserRolesGetStored(), UserRolesIsValid(), UserRolesLogicalToDisplay(), UserRolesLogicalToOdbc(), UserRolesNormalize(), UserRolesSet()

property Username as %String (MAXLEN = 128);

Property methods: UsernameDisplayToLogical(), UsernameGet(), UsernameGetStored(), UsernameIsValid(), UsernameLogicalToDisplay(), UsernameLogicalToOdbc(), UsernameNormalize(), UsernameSet()

Methods

deprecated classmethod DeleteAllSessions() as %Status

THIS CLASS IS DEPRECATED Use HS.FHIRServer.* instead.
API Delete all FHIRSessions Note that because of the OnDeleteSQL trigger in this class, this will also delete any resource streamlets linked to a session via its Session property.

deprecated classmethod DeleteDSTU2(pSession As %String) as %Status

THIS CLASS IS DEPRECATED Use HS.FHIRServer.* instead.

deprecated classmethod DeleteExpiredSessions() as %Status

THIS CLASS IS DEPRECATED Use HS.FHIRServer.* instead.
API Delete expired FHIRSessions ("Expires" in the past)
Note that because of the OnDeleteSQL trigger in this class, this will also delete any resource streamlets linked to an expired session via its Session property.

deprecated classmethod DeleteSTU3(pSession As %String) as %Status

THIS CLASS IS DEPRECATED Use HS.FHIRServer.* instead.

deprecated method IsExpired() as %Boolean

THIS CLASS IS DEPRECATED Use HS.FHIRServer.* instead.

deprecated classmethod IsExpiredHandler(pExpires As %Integer = 0) as %Boolean

THIS CLASS IS DEPRECATED Use HS.FHIRServer.* instead.

deprecated classmethod IsExpiredSQLProc(pExpires As %Integer = 0) as %Boolean [ SQLProc = FHIRSession_IsExpiredSQLProc ]

Projected as the stored procedure: FHIRSession_IsExpiredSQLProc

THIS CLASS IS DEPRECATED Use HS.FHIRServer.* instead.

deprecated final classmethod OnDeleteHandler(id) as %Status

THIS CLASS IS DEPRECATED Use HS.FHIRServer.* instead.
Deletes resource streamlets that have Session="[FHIRSession.Application]||[FHIRSession.SessionId]"

Indexes

index (ExpiresIndex on Expires);

Order by time

Index methods: ExpiresIndexExists()

Triggers

trigger OnDeleteSQL (BEFORE event DELETE);

Inherited Members

Inherited Properties

• Application

Inherited Methods

• %%CLASSNAMELogicalToStorage()
• %%CLASSNAMEStorageToLogical()
• %AddToSaveSet()
• %AddToSyncSet()
• %BMEBuilt()
• %BuildIndicesAsync()
• %BuildIndicesAsyncResponse()
• %CheckConstraints()
• %CheckConstraintsForExtent()
• %ClassIsLatestVersion()
• %ClassName()
• %ComposeOid()
• %ConstructClone()
• %Delete()
• %DeleteExtent()
• %DeleteId()
• %DispatchClassMethod()
• %DispatchGetModified()
• %DispatchGetProperty()
• %DispatchMethod()
• %DispatchSetModified()
• %DispatchSetMultidimProperty()
• %DispatchSetProperty()
• %Exists()
• %ExistsId()
• %Extends()
• %GUID()
• %GUIDSet()
• %GetLock()
• %GetParameter()
• %GetSwizzleObject()
• %Id()
• %InsertBatch()
• %IsA()
• %IsModified()
• %IsNull()
• %KillExtent()
• %KillExtentData()
• %LoadFromMemory()
• %LockExtent()
• %LockId()
• %New()
• %NormalizeObject()
• %ObjectIsNull()
• %ObjectModified()
• %Oid()
• %OnBeforeAddToSync()
• %OnDeleteFinally()
• %OnDetermineClass()
• %OnOpenFinally()
• %OnSaveFinally()
• %Open()
• %OpenId()
• %OriginalNamespace()
• %PackageName()
• %PhysicalAddress()
• %PurgeIndices()
• %Reload()
• %RemoveFromSaveSet()
• %ResolveConcurrencyConflict()
• %RollBack()
• %Save()
• %SaveDirect()
• %SaveIndices()
• %SerializeObject()
• %SetModified()
• %SortBegin()
• %SortEnd()
• %SyncObjectIn()
• %SyncTransport()
• %UnlockExtent()
• %UnlockId()
• %ValidateIndices()
• %ValidateObject()
• %ValidateTable()
• CreateSession()
• EndSession()
• XMLDTD()
• XMLExport()
• XMLExportToStream()
• XMLExportToString()
• XMLNew()
• XMLSchema()
• XMLSchemaNamespace()
• XMLSchemaType()

Storage

Gray indicates storage defined by superclasses.

Storage Model: Storage (HS.Util.SessionData.Session)

^HS.Util.SessionData.SessionD(ID)

=

%%CLASSNAME Application SessionID

Storage Model: Storage (HS.FHIR.SessionData.FHIRSession)

^HS.Util.SessionData.SessionD(ID,"FHIRSession")

=

SessionState Expires PatientResourceId Username UserRoles