Skip to main content

HS.Audit.LogSimple

abstract class HS.Audit.LogSimple

This class provides some stripped down methods for handling specific types of audit events. The full API is in %ZHSLIB.Audit.Log These methods consolidate many of the calls.

Method Inventory

Methods

classmethod BypassRelationshipRule(pUserID As %String, pMPIID As %String, pAuthReason As %String, pAuthBy As %String, pAuthType As %String, pAuthRole As %String)
Audit user bypassing the relationship rule.
classmethod ConsentEvaluation(ByRef pInitiatingLogID As %String, pUserID As %String, pRoles As %String, pAccessGateway As %String, pMRN As %String, pMPIID As %String, pBreakGlass As %Boolean = 0, pPolicySnapshots As %String, pSessionId As %String = "", pProxyUserID As %String = "", pPatName As %String = "") as %Status
API Method: Simplified API to Log a consent evaluation event type. This is invoked on the hub, by the MPI Consent Engine. This returns a %Status, and passes in the initiating log ID that was generated on the hub by the SearchPatient. pMPIID is the patient's MPIID pMRN is in the format facility_"^"_actual MRN_"^"_AssigningAuthority pPolicySnapshots contains the pointers to the 3 relevant snapshots of consent policies needed to do this. in the format system-wide snapshot ID_"^"_facility-wide snapshot ID_"^"_patient snapshot ID pBreakGlass is a boolean - if true, it will log this as consent evaluation with break the glass pSessionId is an option Ensemble session ID
classmethod ConsentUpdate(pUserID As %String = "", pRoles As %String = "", pAccessGateway As %String = "", pUID As %String, pConsentPolicy As %String, pType As %String = "P", pPatName As %String = "") as %Status
API Method: Simplified API to Log a Consent Policy Update event type. This is invoked on the hub, when the policy is updated. This returns a %Status. Unlike many of the other events, this happens in isolation, so it doesn't need to worry about the initiating log ID pUserID and pRoles are for the user on the access gateway. pUID is a the patient's MPI ID, or the facility code for facility policy, or null for system-wide pConsentPolicy contains a string representing both the old and new entire consent policy, with policy ID appended at last. pType is "P" for patient policy (default), "F" for facility policy, or "S" for System-Wide
classmethod CustomPatientModalUse(pMPIID As %String, pChosenValue As %String, pErrored As %Boolean, pSuccess As %Boolean, pProxyUserId As %String)
classmethod RecordRequest(ByRef pInitiatingLogID As %String, pUserID As %String, pRoles As %String, pAccessGateway As %String, pMRN As %String, pSDA="", pCriteria As %String = "", pBreakGlass As %Boolean = 0, pSessionId As %String = "", pProxyUserID As %String = "", pPatName As %String = "", pMPIID As %String = "", pEdgeSession As %String = "") as %Status
API Method: Simplified API to Log a RecordRequest event type. This is invoked on the edge gateway, once a request has been made, before it returns the results. This returns a %Status, and passes in the initiating log ID that was generated on the hub by the SearchPatient. pMRN is in the format facility_"^"_actual MRN_"^"_AssigningAuthority pSDA is the SDA document that gets returned pCriteria contains authorization info pBreakGlass is a boolean - if true, it will log the fetch as break the glass
classmethod SearchPatient(ByRef pInitiatingLogID As %String, pUserID As %String, pRoles As %String, pAccessGateway As %String, pMPIIDList As %String, pMRNList As %String, pCriteria As %String, pBreakGlass As %Boolean = 0, pSessionId As %String = "", pProxyUserID As %String = "") as %Status
API Method: Simplified API to Log a SearchPatient event type. This is invoked on the hub, once a request has been made, before it returns the results. This returns a %Status, and outputs the inintiating log ID (if not already passed in), which needs to be passed to the edge gateway for the RecordRequest, and then used on the access gateway for the ViewRecord event. pUserID and pRoles are for the user on the access gateway. pMPIIDList is a list of MPI IDs, in $LB format pMRNList is a list of MRNs, in $LB format, where each MRN is facility_"^"_actual MRN_"^"_AssigningAuthority pCriteria contains the search criteria, including any authorization info pBreakGlass is a boolean - If true, will log the search as break the glass pSessionId is an optional Ensemble Session Id
classmethod ViewRecords(pDummy, pInitiatingLogID As %String, pUserID As %String, pRoles As %String, pAccessGateway As %String, pMRNList As %String, pSessionId As %String = "", pProxyUserID As %String = "", pPatName As %String = "", pAPI As %Boolean = 0, pMPIIDList="") as %Status
API Method: Simplified API to Log a ViewRecords event type. This is invoked on the access gateway, after the patient lookup, and prior to passing the combined SDA to the viewer. This returns a %Status, and passes in the initiating log ID that was generated on the hub by the SearchPatient. pMRNList is a list of MRNs, in $LB format, where each MRN is facility_"^"_actual MRN_"^"_AssigningAuthority pAPI is used for API based and XDS-b dynamic content fetches pDummy is no longer used
FeedbackOpens in a new tab