HS.Types.AuditAggregateInfo

class HS.Types.AuditAggregateInfo extends %Library.RegisteredObject, %XML.Adaptor, HS.Util.CopyFrom

Property Inventory

Parameters

parameter XMLIGNOREINVALIDTAG = 1;
Inherited description: The XMLIGNOREINVALIDTAG parameter allows the programmer to control handling of unexpected elements in the XML input. The XMLIGNOREINVALIDTAG parameter will only take affect if XMLSEQUENCE = 0 (the default). By default (XMLIGNOREINVALIDTAG = 0), will treat an unexpected element as an error. If XMLIGNOREINVALIDTAG is set = 1 and XMLSEQUENCE = 0, then unexpected elements will be ignored.
parameter XMLIGNORENULL = inputonly;
Inherited description: XMLIGNORENULL allows the programmer to override the default XML handling of empty strings for properties of type %String. By default (XMLIGNORENULL = 0), empty strings in the XML input are stored as $c(0) and $c(0) is written to XML as an empty tag. A missing tag in the XML input is always stored as "" and "" is always output to XML as no tag.

If XMLIGNORENULL is set = 1, then both missing tags in the XML and empty strings are input as "", and both "" and $c(0) are output as empty tags (i.e. <tag></tag>).

If XMLIGNORENULL is set = "inputonly", then both missing tags in the XML and empty strings are input as "". Output of "" and $c(0) are for XMLIGNORENULL = 0: $c(0) is output as an empty tag (i.e. <tag></tag>) and "" is output as no tag.

If XMLIGNORENULL = "runtime" (runtime is not case sensitive), then the behavior of XMLIGNORENULL is determined by the format parameter of XMLExport, XMLImport and %XML.Reader.OpenFile. The default behavior for XMLIGNORENULL="runtime is the same as XMLIGNORENULL=0. Adding "ignorenull" to the format argument changes the behavior to that of XMLIGNORENULL=1. "ignorenull" shoud be separated by a comma from literal/encoded part of the format. Example values for format are "", ",ignorenull", "literal,ignorenull" and "encoded,ignorenull". Note that "inputonly" is equivalent to using ,ignorenull for XMLExport and not for %XML.Reader.

Properties

property ATNAAuditMessageId as %String);
The ATNA Audit Message ID which has been aggregated into this format No longer used as of hscore 13
Property methods: ATNAAuditMessageIdDisplayToLogical(), ATNAAuditMessageIdGet(), ATNAAuditMessageIdIsValid(), ATNAAuditMessageIdLogicalToDisplay(), ATNAAuditMessageIdLogicalToOdbc(), ATNAAuditMessageIdNormalize(), ATNAAuditMessageIdSet()
property ATNAMessage as %String);
For externally received ATNA events - the XML string for the full ATNA message
Property methods: ATNAMessageDisplayToLogical(), ATNAMessageGet(), ATNAMessageIsValid(), ATNAMessageLogicalToDisplay(), ATNAMessageLogicalToOdbc(), ATNAMessageNormalize(), ATNAMessageSet(), ATNAMessageTypeDisplayToLogical(), ATNAMessageTypeGet(), ATNAMessageTypeIsValid(), ATNAMessageTypeLogicalToDisplay(), ATNAMessageTypeLogicalToOdbc(), ATNAMessageTypeNormalize(), ATNAMessageTypeSet()
property ATNAMessageType as %String (VALUELIST = ",DICOM,RFC3881");
For externally received ATNA events - is the XML string stored in ATNAMessage DICOM or RFC3881 Populated for all newly received message - this will be blank for messages predating DICOM support, and therefore treated as RFC3881
Property methods: ATNAMessageTypeDisplayToLogical(), ATNAMessageTypeGet(), ATNAMessageTypeIsValid(), ATNAMessageTypeLogicalToDisplay(), ATNAMessageTypeLogicalToOdbc(), ATNAMessageTypeNormalize(), ATNAMessageTypeSet()
property ActionCode as %String);
from IHE event
Property methods: ActionCodeDisplayToLogical(), ActionCodeGet(), ActionCodeIsValid(), ActionCodeLogicalToDisplay(), ActionCodeLogicalToOdbc(), ActionCodeNormalize(), ActionCodeSet()
property AdditionalInfo as array of HS.Types.AdditionalInfoItem;
To hold misc. other items
Property methods: AdditionalInfoBuildValueArray(), AdditionalInfoCollectionToDisplay(), AdditionalInfoCollectionToOdbc(), AdditionalInfoDisplayToCollection(), AdditionalInfoDisplayToLogical(), AdditionalInfoGet(), AdditionalInfoGetObject(), AdditionalInfoGetObjectId(), AdditionalInfoGetSwizzled(), AdditionalInfoIsValid(), AdditionalInfoLogicalToDisplay(), AdditionalInfoLogicalToOdbc(), AdditionalInfoNormalize(), AdditionalInfoOdbcToCollection(), AdditionalInfoSet(), AdditionalInfoSetObject(), AdditionalInfoSetObjectId()
property AuditSourceID as %String);
From IHE Audit Source
Property methods: AuditSourceIDDisplayToLogical(), AuditSourceIDGet(), AuditSourceIDIsValid(), AuditSourceIDLogicalToDisplay(), AuditSourceIDLogicalToOdbc(), AuditSourceIDNormalize(), AuditSourceIDSet()
property Criteria as %String);
Search or other criteria
Property methods: CriteriaDisplayToLogical(), CriteriaGet(), CriteriaIsValid(), CriteriaLogicalToDisplay(), CriteriaLogicalToOdbc(), CriteriaNormalize(), CriteriaSet()
property DestinationNetworkAccess as %String);
From IHE event destination ;
Property methods: DestinationNetworkAccessDisplayToLogical(), DestinationNetworkAccessGet(), DestinationNetworkAccessIsValid(), DestinationNetworkAccessLogicalToDisplay(), DestinationNetworkAccessLogicalToOdbc(), DestinationNetworkAccessNormalize(), DestinationNetworkAccessSet()
property DestinationURI as %String);
The source of the event being audited (when available) Each IHE audit message includes a destination based on the SOAP addressing header
Property methods: DestinationURIDisplayToLogical(), DestinationURIGet(), DestinationURIIsValid(), DestinationURILogicalToDisplay(), DestinationURILogicalToOdbc(), DestinationURINormalize(), DestinationURISet()
property DocumentId as %String);
Push or other document ID - can contain repository gateway prefix For XDSb documents, this will contain info copied from the first document, in format "XDSb/"_pHomeCommunityID_"/"_pRepositoryID_"/"_pDocumentID
Property methods: DocumentIdDisplayToLogical(), DocumentIdGet(), DocumentIdIsValid(), DocumentIdLogicalToDisplay(), DocumentIdLogicalToOdbc(), DocumentIdNormalize(), DocumentIdSet()
property EnsembleSessionId as %String);
The Ensemble session ID, where available
Property methods: EnsembleSessionIdDisplayToLogical(), EnsembleSessionIdGet(), EnsembleSessionIdIsValid(), EnsembleSessionIdLogicalToDisplay(), EnsembleSessionIdLogicalToOdbc(), EnsembleSessionIdNormalize(), EnsembleSessionIdSet()
property EventDateTime as %TimeStamp;
UTC Time - not what you usually want for reporting. Use computed LocalDateTime for display, and computed IndexedDate for efficient queries
Property methods: EventDateTimeDisplayToLogical(), EventDateTimeGet(), EventDateTimeIsValid(), EventDateTimeLogicalToDisplay(), EventDateTimeLogicalToXSD(), EventDateTimeNormalize(), EventDateTimeOdbcToLogical(), EventDateTimeSet(), EventDateTimeXSDToLogical()
property EventInfo as %String (MAXLEN = 180);
For IHE events, this will contain the event type triplet_"^"_the event ID triplet. Should someone submit an IHE event as an aggregation via the API, this must be populated.
Property methods: EventInfoDisplayToLogical(), EventInfoGet(), EventInfoIsValid(), EventInfoLogicalToDisplay(), EventInfoLogicalToOdbc(), EventInfoNormalize(), EventInfoSet()
property EventSubType as %String);
Property methods: EventSubTypeDisplayToLogical(), EventSubTypeGet(), EventSubTypeIsValid(), EventSubTypeLogicalToDisplay(), EventSubTypeLogicalToOdbc(), EventSubTypeNormalize(), EventSubTypeSet()
property EventType as %String);
Property methods: EventTypeDisplayToLogical(), EventTypeGet(), EventTypeIsValid(), EventTypeLogicalToDisplay(), EventTypeLogicalToOdbc(), EventTypeNormalize(), EventTypeSet()
property InitiatedAt as %String);
The hub or gateway associated with the initiating log (where available)
Property methods: InitiatedAtDisplayToLogical(), InitiatedAtGet(), InitiatedAtIsValid(), InitiatedAtLogicalToDisplay(), InitiatedAtLogicalToOdbc(), InitiatedAtNormalize(), InitiatedAtSet()
property InitiatingLogId as %String);
The Native Audit log ID, where the sequence of transactions started (where available)
Property methods: InitiatingLogIdDisplayToLogical(), InitiatingLogIdGet(), InitiatingLogIdIsValid(), InitiatingLogIdLogicalToDisplay(), InitiatingLogIdLogicalToOdbc(), InitiatingLogIdNormalize(), InitiatingLogIdSet()
property IsSource as %Boolean;
recorded for IHE events logged by HealthShare - most of these log two events, one for the source and one for the destination
Property methods: IsSourceDisplayToLogical(), IsSourceGet(), IsSourceIsValid(), IsSourceLogicalToDisplay(), IsSourceLogicalToXSD(), IsSourceNormalize(), IsSourceSet(), IsSourceXSDToLogical()
property MPIIDs as list of %String);
The list of MPIIDs associated with thie transaction (0 or more)
Property methods: MPIIDsBuildValueArray(), MPIIDsCollectionToDisplay(), MPIIDsCollectionToOdbc(), MPIIDsDisplayToCollection(), MPIIDsDisplayToLogical(), MPIIDsGet(), MPIIDsGetObject(), MPIIDsGetObjectId(), MPIIDsGetSwizzled(), MPIIDsIsValid(), MPIIDsLogicalToDisplay(), MPIIDsLogicalToOdbc(), MPIIDsNormalize(), MPIIDsOdbcToCollection(), MPIIDsSet(), MPIIDsSetObject(), MPIIDsSetObjectId()
property MRNs as list of %String);
The list of MRNs associate with this transaction (0 or more) Each is of format: Facility^number^Assigning Authority (number might actually be a string)
Property methods: MRNsBuildValueArray(), MRNsCollectionToDisplay(), MRNsCollectionToOdbc(), MRNsDisplayToCollection(), MRNsDisplayToLogical(), MRNsGet(), MRNsGetObject(), MRNsGetObjectId(), MRNsGetSwizzled(), MRNsIsValid(), MRNsLogicalToDisplay(), MRNsLogicalToOdbc(), MRNsNormalize(), MRNsOdbcToCollection(), MRNsSet(), MRNsSetObject(), MRNsSetObjectId()
property Outcome as %String);
From IHE event
Property methods: OutcomeDisplayToLogical(), OutcomeGet(), OutcomeIsValid(), OutcomeLogicalToDisplay(), OutcomeLogicalToOdbc(), OutcomeNormalize(), OutcomeSet()
property PatientName as %String);
The patient's name, for those events where we can reasonably include a single patient name If there are multiple ones, this can contain the name of the first patient
Property methods: PatientNameDisplayToLogical(), PatientNameGet(), PatientNameIsValid(), PatientNameLogicalToDisplay(), PatientNameLogicalToOdbc(), PatientNameNormalize(), PatientNameSet()
property ProviderId as %String);
For provider directory (HPD, etc.) transaction
Property methods: ProviderIdDisplayToLogical(), ProviderIdGet(), ProviderIdIsValid(), ProviderIdLogicalToDisplay(), ProviderIdLogicalToOdbc(), ProviderIdNormalize(), ProviderIdSet()
property ProviderName as %String);
For provider directory (HPD, etc.) transaction
Property methods: ProviderNameDisplayToLogical(), ProviderNameGet(), ProviderNameIsValid(), ProviderNameLogicalToDisplay(), ProviderNameLogicalToOdbc(), ProviderNameNormalize(), ProviderNameSet()
property ProxyUserName as %String);
UserName is doing the request on behalf of the ProxyUser
Property methods: ProxyUserNameDisplayToLogical(), ProxyUserNameGet(), ProxyUserNameIsValid(), ProxyUserNameLogicalToDisplay(), ProxyUserNameLogicalToOdbc(), ProxyUserNameNormalize(), ProxyUserNameSet()
property QueryRequestID as %String);
From IHE/ATNA Query
Property methods: QueryRequestIDDisplayToLogical(), QueryRequestIDGet(), QueryRequestIDIsValid(), QueryRequestIDLogicalToDisplay(), QueryRequestIDLogicalToOdbc(), QueryRequestIDNormalize(), QueryRequestIDSet()
property RecordedAt as %String);
The hub or gateway where this audit event was recorded (where available)
Property methods: RecordedAtDisplayToLogical(), RecordedAtGet(), RecordedAtIsValid(), RecordedAtLogicalToDisplay(), RecordedAtLogicalToOdbc(), RecordedAtNormalize(), RecordedAtSet()
property RecordedLogId as %String);
The native Audit log ID associated with the particular transaction (where available)
Property methods: RecordedLogIdDisplayToLogical(), RecordedLogIdGet(), RecordedLogIdIsValid(), RecordedLogIdLogicalToDisplay(), RecordedLogIdLogicalToOdbc(), RecordedLogIdNormalize(), RecordedLogIdSet()
property Roles as %String);
Property methods: RolesDisplayToLogical(), RolesGet(), RolesIsValid(), RolesLogicalToDisplay(), RolesLogicalToOdbc(), RolesNormalize(), RolesSet()
property SourceNetworkAccess as %String);
From IHE event source
Property methods: SourceNetworkAccessDisplayToLogical(), SourceNetworkAccessGet(), SourceNetworkAccessIsValid(), SourceNetworkAccessLogicalToDisplay(), SourceNetworkAccessLogicalToOdbc(), SourceNetworkAccessNormalize(), SourceNetworkAccessSet()
property SourceURI as %String);
The source of the event being audited (when available) Each IHE audit message includes a source based on the SOAP addressing header
Property methods: SourceURIDisplayToLogical(), SourceURIGet(), SourceURIIsValid(), SourceURILogicalToDisplay(), SourceURILogicalToOdbc(), SourceURINormalize(), SourceURISet()
property SubmissionSetUniqueID as %String);
From XDS submission set
Property methods: SubmissionSetUniqueIDDisplayToLogical(), SubmissionSetUniqueIDGet(), SubmissionSetUniqueIDIsValid(), SubmissionSetUniqueIDLogicalToDisplay(), SubmissionSetUniqueIDLogicalToOdbc(), SubmissionSetUniqueIDNormalize(), SubmissionSetUniqueIDSet()
property UserFullName as %String);
From IHE human requestor
Property methods: UserFullNameDisplayToLogical(), UserFullNameGet(), UserFullNameIsValid(), UserFullNameLogicalToDisplay(), UserFullNameLogicalToOdbc(), UserFullNameNormalize(), UserFullNameSet()
property UserName as %String);
Property methods: UserNameDisplayToLogical(), UserNameGet(), UserNameIsValid(), UserNameLogicalToDisplay(), UserNameLogicalToOdbc(), UserNameNormalize(), UserNameSet()

Inherited Members

Inherited Methods

Subclasses

Feedback