Package com.ibm.fhir.model.resource

Class AuditEvent

  • All Implemented Interfaces:
    Visitable
    @Generated("com.ibm.fhir.tools.CodeGenerator")
public class AuditEvent
extends DomainResource
    A record of an event made for purposes of maintaining a security log. Typical uses include detection of intrusion attempts and monitoring for inappropriate usage.

    Maturity level: FMM3 (Trial Use)

    • Method Detail

      • getType

        public Coding getType()
        Identifier for a family of the event. For example, a menu item, program, rule, policy, function code, application name or URL. It identifies the performed function.
        Returns:
        An immutable object of type Coding that is non-null.

      • getSubtype

        public List<Coding> getSubtype()
        Identifier for the category of event.
        Returns:
        An unmodifiable list containing immutable objects of type Coding that may be empty.

      • getAction

        public AuditEventAction getAction()
        Indicator for type of action performed during the event that generated the audit.
        Returns:
        An immutable object of type AuditEventAction that may be null.

      • getPeriod

        public Period getPeriod()
        The period during which the activity occurred.
        Returns:
        An immutable object of type Period that may be null.

      • getRecorded

        public Instant getRecorded()
        The time when the event was recorded.
        Returns:
        An immutable object of type Instant that is non-null.

      • getOutcome

        public AuditEventOutcome getOutcome()
        Indicates whether the event succeeded or failed.
        Returns:
        An immutable object of type AuditEventOutcome that may be null.

      • getOutcomeDesc

        public String getOutcomeDesc()
        A free text description of the outcome of the event.
        Returns:
        An immutable object of type String that may be null.

      • getPurposeOfEvent

        public List<CodeableConcept> getPurposeOfEvent()
        The purposeOfUse (reason) that was used during the event being recorded.
        Returns:
        An unmodifiable list containing immutable objects of type CodeableConcept that may be empty.

      • getAgent

        public List<AuditEvent.Agent> getAgent()
        An actor taking an active role in the event or activity that is logged.
        Returns:
        An unmodifiable list containing immutable objects of type AuditEvent.Agent that is non-empty.

      • getEntity

        public List<AuditEvent.Entity> getEntity()
        Specific instances of data or objects that have been accessed.
        Returns:
        An unmodifiable list containing immutable objects of type AuditEvent.Entity that may be empty.

      • accept

        public void accept​(String elementName,
                   int elementIndex,
                   Visitor visitor)
        Description copied from interface: Visitable
        Accept a Visitor and invoke the appropriate visit methods. A typical implementation would look like this: 
         if (visitor.preVisit(this)) {
     visitor.visitStart(elementName, elementIndex, this);
     if (visitor.visit(elementName, elementIndex, this)) {
         // visit children
     }
     visitor.visitEnd(elementName, elementIndex, this);
     visitor.postVisit(this);
 }
        Specified by:
        accept in interface Visitable
        Specified by:
        accept in class AbstractVisitable
        Parameters:
        elementName - the name of the element in the context of this visit
        elementIndex - the index of the element in a list or -1 if it is not contained within a List
        visitor - the visitor to use

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class Object