HS.Push.MessageCenter.Document
persistent class HS.Push.MessageCenter.Document extends HS.Push.DocumentRegistry
SQL Table Name: HS_Push_MessageCenter.Document
Property Inventory
Method Inventory
- FolderDocumentCount()
- GetDocumentInfo()
- GetExternalDirectFacility()
- GetMessageCount()
- ListFolderDocumentEventTypesWebClose()
- ListFolderDocumentEventTypesWebExecute()
- ListFolderDocumentEventTypesWebFetch()
- ListFolderDocumentsWebClose()
- ListFolderDocumentsWebExecute()
- ListFolderDocumentsWebFetch()
- MarkIncorporated()
- MoveToFolder()
- QueryFilteredPage()
- ReadFlag()
- UpdateFolder()
Properties
property CanBeIncorporated as %Boolean [ InitialExpression = 0 , Transient ];
this gets computed by GetDocumentInfo
Property methods: CanBeIncorporatedDisplayToLogical(), CanBeIncorporatedGet(), CanBeIncorporatedIsValid(), CanBeIncorporatedLogicalToDisplay(), CanBeIncorporatedLogicalToXSD(), CanBeIncorporatedNormalize(), CanBeIncorporatedSet(), CanBeIncorporatedXSDToLogical()
property FolderId as %String;
Current Folder
Property methods: FolderIdDisplayToLogical(), FolderIdGet(), FolderIdGetStored(), FolderIdIsValid(), FolderIdLogicalToDisplay(), FolderIdLogicalToOdbc(), FolderIdNormalize(), FolderIdSet()
property Incorporated as %TimeStamp;
If this has been incorporated (added) into a patient's record, this records when it happened
Property methods: IncorporatedDisplayToLogical(), IncorporatedGet(), IncorporatedGetStored(), IncorporatedIsValid(), IncorporatedLogicalToDisplay(), IncorporatedLogicalToXSD(), IncorporatedNormalize(), IncorporatedOdbcToLogical(), IncorporatedSet(), IncorporatedXSDToLogical()
property IncorporatedBy as %String (MAXLEN = 200);
THe user who did it
Property methods: IncorporatedByDisplayToLogical(), IncorporatedByGet(), IncorporatedByGetStored(), IncorporatedByIsValid(), IncorporatedByLogicalToDisplay(), IncorporatedByLogicalToOdbc(), IncorporatedByNormalize(), IncorporatedBySet()
property Received as %TimeStamp;
Property methods: ReceivedDisplayToLogical(), ReceivedGet(), ReceivedGetStored(), ReceivedIsValid(), ReceivedLogicalToDisplay(), ReceivedLogicalToXSD(), ReceivedNormalize(), ReceivedOdbcToLogical(), ReceivedSet(), ReceivedXSDToLogical()
property UnRead as %Boolean [ InitialExpression = 1 ];
Property methods: UnReadDisplayToLogical(), UnReadGet(), UnReadGetStored(), UnReadIsValid(), UnReadLogicalToDisplay(), UnReadLogicalToXSD(), UnReadNormalize(), UnReadSet(), UnReadXSDToLogical()
property Updated as %TimeStamp;
Property methods: UpdatedDisplayToLogical(), UpdatedGet(), UpdatedGetStored(), UpdatedIsValid(), UpdatedLogicalToDisplay(), UpdatedLogicalToXSD(), UpdatedNormalize(), UpdatedOdbcToLogical(), UpdatedSet(), UpdatedXSDToLogical()
Methods
classmethod FolderDocumentCount(pClinicianId As %String, pType As %String, pIncludeRead As %Integer = 0) as %Integer
Returns the number of documents in a folder (including by default only unread documents)
classmethod GetDocumentInfo(pRegistryId, ByRef pDocument As HS.Push.MessageCenter.Document)
classmethod GetExternalDirectFacility() as %String
MSP - 2024-01-18 - New function to get total number of messages in inbox to calculate pagination
classmethod ListFolderDocumentEventTypesWebExecute(ByRef qHandle As %Binary, pFolderId As %String, pClinicianId As %String, pRegDocId As %String, pFilterFields As %String, pFilterValues As %String) as %Status
Returns all the distinct event types present within the folder, for filtering
classmethod ListFolderDocumentEventTypesWebFetch(ByRef qHandle As %Binary, ByRef Row As %List, ByRef AtEnd As %Integer = 0) as %Status
classmethod ListFolderDocumentsWebExecute(ByRef qHandle As %Binary, pFolderId As %String, pClinicianId As %String, pRegDocId As %String, pFilterFields As %String, pFilterValues As %String, pPageSize=500, pCurrentPage=1) as %Status
classmethod ListFolderDocumentsWebFetch(ByRef qHandle As %Binary, ByRef Row As %List, ByRef AtEnd As %Integer = 0) as %Status
classmethod MarkIncorporated(pRegistryId, pUserID)
classmethod MoveToFolder(pRegDocId, pFolderId, Output pDocumentId) as %Status
classmethod QueryFilteredPage(pFolderId As %String, pClinicianId As %String, pageAndFilterInfo As %String = "") as %SQL.StatementResult
classmethod ReadFlag(pRegDocId, pUnRead) as %Status
classmethod UpdateFolder(pCustomFolder, pDeletedFolder)
Supports deletion of a custom folder in the Clinical Message Center. When a customer folder is deleted, all existing
documents are moved to the clinician's deleted folder.
Queries
query ListFolderDocumentEventTypesWeb(pFolderId, pClinicianId As %String, pRegDocId As %String = "", pFilterFields As %String = "", pFilterValues As %String = "")
query ListFolderDocumentsWeb(pFolderId, pClinicianId As %String, pRegDocId As %String = "", pFilterFields As %String = "", pFilterValues As %String = "", pPageSize=500, pCurrentPage=1)
Selects ID As %String, AssigningAuthority As %String, EventType As %String, Facility As %String, PatientName As %String, MPIID As %String, Identifiers As %String, Received As %TimeStamp, UnRead As %Boolean, Updated As %TimeStamp, SubscriptionId As %String, ReceivedFrom As %String, Subject As %String, ToList As %String, Attachment As %Boolean
used for two purposes:
1. For listing the contents of a folder, like the inbox - pRegDocId would be ""
2. For fetching the info for just a single document, with the message center is invoked from an external link
In this case, it only uses pRegDocId
Indexes
index (FolderIndex on FolderId);
Index methods: FolderIndexExists()
index (UserIdx on Subscription.UserId);
Index methods: UserIdxExists()
Inherited Members
Inherited Properties
- Address
- AssigningAuthority
- AssigningAuthorityOID
- Attachments
- BlindList
- CCList
- DOB
- DocumentId
- Download
- Draft
- EventType
- Facility
- FacilityOID
- FirstName
- Identifiers
- InfoTypes
- IsExternal
- LastName
- MPIID
- MRN
- RecipientList
- RepositoryGWEndPoint
- RepositoryGWID
- RepositoryGateway
- SenderEmail
- SenderID
- SenderName
- Sent
- Sex
- Subscription
- ToList
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()
- CopyFrom()
- GetEventName()
- GetRepositoryGWEndPoint()
- XMLDTD()
- XMLExport()
- XMLExportToStream()
- XMLExportToString()
- XMLNew()
- XMLSchema()
- XMLSchemaNamespace()
- XMLSchemaType()
Storage
Gray indicates storage defined by superclasses.
Storage Model: Storage (HS.Push.DocumentRegistry)
^HS.Push.DocumentRegistryD(ID) |
= | %%CLASSNAME
Subscription
MPIID
DocumentId
RepositoryGateway
EventType
InfoTypes
Facility
AssigningAuthority
MRN
LastName
FirstName
RepositoryGWID
SenderID
SenderName
SenderEmail
Identifiers
RecipientList
ToList
CCList
BlindList
Draft
Sent
Address
Sex
DOB
Attachments
FacilityOID
AssigningAuthorityOID
Download
IsExternal
|
Storage Model: Storage (HS.Push.MessageCenter.Document)
^HS.Push.DocumentRegistryD(ID,"Document") |
= | FolderId
UnRead
Received
Updated
From
ReceivedFrom
Subject
HasBeenIncorporated
Incorporated
IncorporatedBy
|