Class AuditEvent

  • All Implemented Interfaces:
    ca.uhn.fhir.model.api.IElement, Serializable, org.hl7.fhir.instance.model.api.IAnyResource, org.hl7.fhir.instance.model.api.IBase, org.hl7.fhir.instance.model.api.IBaseHasExtensions, org.hl7.fhir.instance.model.api.IBaseHasModifierExtensions, org.hl7.fhir.instance.model.api.IBaseResource, org.hl7.fhir.instance.model.api.IDomainResource

    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.
    See Also:
    Serialized Form
    • Field Detail

      • type

        protected Coding type
        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.
      • purposeOfEvent

        protected List<Coding> purposeOfEvent
        The purposeOfUse (reason) that was used during the event being recorded.
      • SP_SITE

        public static final String SP_SITE
        Search parameter: site

        Description: Logical source location within the enterprise
        Type: token
        Path: AuditEvent.source.site

        See Also:
        Constant Field Values
      • SITE

        public static final ca.uhn.fhir.rest.gclient.TokenClientParam SITE
        Fluent Client search parameter constant for site

        Description: Logical source location within the enterprise
        Type: token
        Path: AuditEvent.source.site

      • SP_ENTITY

        public static final String SP_ENTITY
        Search parameter: entity

        Description: Specific instance of resource (e.g. versioned)
        Type: reference
        Path: AuditEvent.entity.reference

        See Also:
        Constant Field Values
      • ENTITY

        public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam ENTITY
        Fluent Client search parameter constant for entity

        Description: Specific instance of resource (e.g. versioned)
        Type: reference
        Path: AuditEvent.entity.reference

      • INCLUDE_ENTITY

        public static final ca.uhn.fhir.model.api.Include INCLUDE_ENTITY
        Constant for fluent queries to be used to add include statements. Specifies the path value of "AuditEvent:entity".
      • ENTITY_TYPE

        public static final ca.uhn.fhir.rest.gclient.TokenClientParam ENTITY_TYPE
        Fluent Client search parameter constant for entity-type

        Description: Type of object involved
        Type: token
        Path: AuditEvent.entity.type

      • SP_TYPE

        public static final String SP_TYPE
        Search parameter: type

        Description: Type/identifier of event
        Type: token
        Path: AuditEvent.type

        See Also:
        Constant Field Values
      • TYPE

        public static final ca.uhn.fhir.rest.gclient.TokenClientParam TYPE
        Fluent Client search parameter constant for type

        Description: Type/identifier of event
        Type: token
        Path: AuditEvent.type

      • SP_DATE

        public static final String SP_DATE
        Search parameter: date

        Description: Time when the event occurred on source
        Type: date
        Path: AuditEvent.recorded

        See Also:
        Constant Field Values
      • DATE

        public static final ca.uhn.fhir.rest.gclient.DateClientParam DATE
        Fluent Client search parameter constant for date

        Description: Time when the event occurred on source
        Type: date
        Path: AuditEvent.recorded

      • SP_AGENT

        public static final String SP_AGENT
        Search parameter: agent

        Description: Direct reference to resource
        Type: reference
        Path: AuditEvent.agent.reference

        See Also:
        Constant Field Values
      • AGENT

        public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam AGENT
        Fluent Client search parameter constant for agent

        Description: Direct reference to resource
        Type: reference
        Path: AuditEvent.agent.reference

      • INCLUDE_AGENT

        public static final ca.uhn.fhir.model.api.Include INCLUDE_AGENT
        Constant for fluent queries to be used to add include statements. Specifies the path value of "AuditEvent:agent".
      • SP_AGENT_NAME

        public static final String SP_AGENT_NAME
        Search parameter: agent-name

        Description: Human-meaningful name for the agent
        Type: string
        Path: AuditEvent.agent.name

        See Also:
        Constant Field Values
      • AGENT_NAME

        public static final ca.uhn.fhir.rest.gclient.StringClientParam AGENT_NAME
        Fluent Client search parameter constant for agent-name

        Description: Human-meaningful name for the agent
        Type: string
        Path: AuditEvent.agent.name

      • SP_ENTITY_ID

        public static final String SP_ENTITY_ID
        Search parameter: entity-id

        Description: Specific instance of object (e.g. versioned)
        Type: token
        Path: AuditEvent.entity.identifier

        See Also:
        Constant Field Values
      • ENTITY_ID

        public static final ca.uhn.fhir.rest.gclient.TokenClientParam ENTITY_ID
        Fluent Client search parameter constant for entity-id

        Description: Specific instance of object (e.g. versioned)
        Type: token
        Path: AuditEvent.entity.identifier

      • SP_PATIENT

        public static final String SP_PATIENT
        Search parameter: patient

        Description: Direct reference to resource
        Type: reference
        Path: AuditEvent.agent.reference, AuditEvent.entity.reference

        See Also:
        Constant Field Values
      • PATIENT

        public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam PATIENT
        Fluent Client search parameter constant for patient

        Description: Direct reference to resource
        Type: reference
        Path: AuditEvent.agent.reference, AuditEvent.entity.reference

      • INCLUDE_PATIENT

        public static final ca.uhn.fhir.model.api.Include INCLUDE_PATIENT
        Constant for fluent queries to be used to add include statements. Specifies the path value of "AuditEvent:patient".
      • SP_SOURCE

        public static final String SP_SOURCE
        Search parameter: source

        Description: The identity of source detecting the event
        Type: token
        Path: AuditEvent.source.identifier

        See Also:
        Constant Field Values
      • SOURCE

        public static final ca.uhn.fhir.rest.gclient.TokenClientParam SOURCE
        Fluent Client search parameter constant for source

        Description: The identity of source detecting the event
        Type: token
        Path: AuditEvent.source.identifier

      • SP_ALTID

        public static final String SP_ALTID
        Search parameter: altid

        Description: Alternative User id e.g. authentication
        Type: token
        Path: AuditEvent.agent.altId

        See Also:
        Constant Field Values
      • ALTID

        public static final ca.uhn.fhir.rest.gclient.TokenClientParam ALTID
        Fluent Client search parameter constant for altid

        Description: Alternative User id e.g. authentication
        Type: token
        Path: AuditEvent.agent.altId

      • SP_ADDRESS

        public static final String SP_ADDRESS
        Search parameter: address

        Description: Identifier for the network access point of the user device
        Type: token
        Path: AuditEvent.agent.network.address

        See Also:
        Constant Field Values
      • ADDRESS

        public static final ca.uhn.fhir.rest.gclient.TokenClientParam ADDRESS
        Fluent Client search parameter constant for address

        Description: Identifier for the network access point of the user device
        Type: token
        Path: AuditEvent.agent.network.address

      • SP_SUBTYPE

        public static final String SP_SUBTYPE
        Search parameter: subtype

        Description: More specific type/id for the event
        Type: token
        Path: AuditEvent.subtype

        See Also:
        Constant Field Values
      • SUBTYPE

        public static final ca.uhn.fhir.rest.gclient.TokenClientParam SUBTYPE
        Fluent Client search parameter constant for subtype

        Description: More specific type/id for the event
        Type: token
        Path: AuditEvent.subtype

      • SP_ACTION

        public static final String SP_ACTION
        Search parameter: action

        Description: Type of action performed during the event
        Type: token
        Path: AuditEvent.action

        See Also:
        Constant Field Values
      • ACTION

        public static final ca.uhn.fhir.rest.gclient.TokenClientParam ACTION
        Fluent Client search parameter constant for action

        Description: Type of action performed during the event
        Type: token
        Path: AuditEvent.action

      • SP_POLICY

        public static final String SP_POLICY
        Search parameter: policy

        Description: Policy that authorized event
        Type: uri
        Path: AuditEvent.agent.policy

        See Also:
        Constant Field Values
      • POLICY

        public static final ca.uhn.fhir.rest.gclient.UriClientParam POLICY
        Fluent Client search parameter constant for policy

        Description: Policy that authorized event
        Type: uri
        Path: AuditEvent.agent.policy

      • SP_USER

        public static final String SP_USER
        Search parameter: user

        Description: Unique identifier for the user
        Type: token
        Path: AuditEvent.agent.userId

        See Also:
        Constant Field Values
      • USER

        public static final ca.uhn.fhir.rest.gclient.TokenClientParam USER
        Fluent Client search parameter constant for user

        Description: Unique identifier for the user
        Type: token
        Path: AuditEvent.agent.userId

      • ENTITY_NAME

        public static final ca.uhn.fhir.rest.gclient.StringClientParam ENTITY_NAME
        Fluent Client search parameter constant for entity-name

        Description: Descriptor for entity
        Type: string
        Path: AuditEvent.entity.name