Class AuditEvent.Event

  • All Implemented Interfaces:
    ca.uhn.fhir.model.api.ICompositeElement, ca.uhn.fhir.model.api.IElement, ca.uhn.fhir.model.api.IIdentifiableElement, ca.uhn.fhir.model.api.IResourceBlock, ca.uhn.fhir.model.api.ISupportsUndeclaredExtensions, Serializable, org.hl7.fhir.instance.model.api.IBase
    Enclosing class:
    AuditEvent

    public static class AuditEvent.Event
    extends ca.uhn.fhir.model.api.BaseIdentifiableElement
    implements ca.uhn.fhir.model.api.IResourceBlock
    Block class for child element: AuditEvent.event ()

    Definition: Identifies the name, action type, time, and disposition of the audited event

    See Also:
    Serialized Form
    • Constructor Detail

    • Method Detail

      • isEmpty

        public boolean isEmpty()
        Specified by:
        isEmpty in interface org.hl7.fhir.instance.model.api.IBase
      • getAllPopulatedChildElementsOfType

        public <T extends ca.uhn.fhir.model.api.IElement> List<T> getAllPopulatedChildElementsOfType​(Class<T> theType)
        Specified by:
        getAllPopulatedChildElementsOfType in interface ca.uhn.fhir.model.api.ICompositeElement
      • getType

        public CodingDt getType()
        Gets the value(s) for type (). creating it if it does not exist. Will not return null.

        Definition: 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

      • setType

        public AuditEvent.Event setType​(CodingDt theValue)
        Sets the value(s) for type ()

        Definition: 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

      • getSubtype

        public List<CodingDtgetSubtype()
        Gets the value(s) for subtype (). creating it if it does not exist. Will not return null.

        Definition: Identifier for the category of event

      • addSubtype

        public CodingDt addSubtype()
        Adds and returns a new value for subtype ()

        Definition: Identifier for the category of event

      • addSubtype

        public AuditEvent.Event addSubtype​(CodingDt theValue)
        Adds a given new value for subtype ()

        Definition: Identifier for the category of event

        Parameters:
        theValue - The subtype to add (must not be null)
      • getSubtypeFirstRep

        public CodingDt getSubtypeFirstRep()
        Gets the first repetition for subtype (), creating it if it does not already exist.

        Definition: Identifier for the category of event

      • getActionElement

        public ca.uhn.fhir.model.primitive.BoundCodeDt<AuditEventActionEnumgetActionElement()
        Gets the value(s) for action (). creating it if it does not exist. Will not return null.

        Definition: Indicator for type of action performed during the event that generated the audit

      • getAction

        public String getAction()
        Gets the value(s) for action (). creating it if it does not exist. This method may return null.

        Definition: Indicator for type of action performed during the event that generated the audit

      • setAction

        public AuditEvent.Event setAction​(ca.uhn.fhir.model.primitive.BoundCodeDt<AuditEventActionEnum> theValue)
        Sets the value(s) for action ()

        Definition: Indicator for type of action performed during the event that generated the audit

      • getDateTimeElement

        public ca.uhn.fhir.model.primitive.InstantDt getDateTimeElement()
        Gets the value(s) for dateTime (). creating it if it does not exist. Will not return null.

        Definition: The time when the event occurred on the source

      • getDateTime

        public Date getDateTime()
        Gets the value(s) for dateTime (). creating it if it does not exist. This method may return null.

        Definition: The time when the event occurred on the source

      • setDateTime

        public AuditEvent.Event setDateTime​(ca.uhn.fhir.model.primitive.InstantDt theValue)
        Sets the value(s) for dateTime ()

        Definition: The time when the event occurred on the source

      • setDateTime

        public AuditEvent.Event setDateTime​(Date theDate,
                                            ca.uhn.fhir.model.api.TemporalPrecisionEnum thePrecision)
        Sets the value for dateTime ()

        Definition: The time when the event occurred on the source

      • getOutcomeElement

        public ca.uhn.fhir.model.primitive.BoundCodeDt<AuditEventOutcomeEnumgetOutcomeElement()
        Gets the value(s) for outcome (). creating it if it does not exist. Will not return null.

        Definition: Indicates whether the event succeeded or failed

      • getOutcome

        public String getOutcome()
        Gets the value(s) for outcome (). creating it if it does not exist. This method may return null.

        Definition: Indicates whether the event succeeded or failed

      • getOutcomeDescElement

        public ca.uhn.fhir.model.primitive.StringDt getOutcomeDescElement()
        Gets the value(s) for outcomeDesc (). creating it if it does not exist. Will not return null.

        Definition: A free text description of the outcome of the event

      • getOutcomeDesc

        public String getOutcomeDesc()
        Gets the value(s) for outcomeDesc (). creating it if it does not exist. This method may return null.

        Definition: A free text description of the outcome of the event

      • setOutcomeDesc

        public AuditEvent.Event setOutcomeDesc​(ca.uhn.fhir.model.primitive.StringDt theValue)
        Sets the value(s) for outcomeDesc ()

        Definition: A free text description of the outcome of the event

      • getPurposeOfEvent

        public List<CodingDtgetPurposeOfEvent()
        Gets the value(s) for purposeOfEvent (). creating it if it does not exist. Will not return null.

        Definition: The purposeOfUse (reason) that was used during the event being recorded.

      • addPurposeOfEvent

        public CodingDt addPurposeOfEvent()
        Adds and returns a new value for purposeOfEvent ()

        Definition: The purposeOfUse (reason) that was used during the event being recorded.

      • addPurposeOfEvent

        public AuditEvent.Event addPurposeOfEvent​(CodingDt theValue)
        Adds a given new value for purposeOfEvent ()

        Definition: The purposeOfUse (reason) that was used during the event being recorded.

        Parameters:
        theValue - The purposeOfEvent to add (must not be null)
      • getPurposeOfEventFirstRep

        public CodingDt getPurposeOfEventFirstRep()
        Gets the first repetition for purposeOfEvent (), creating it if it does not already exist.

        Definition: The purposeOfUse (reason) that was used during the event being recorded.