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:
  • Field Details

    • 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.
    • subtype

      protected List<Coding> subtype
      Identifier for the category of event.
    • action

      Indicator for type of action performed during the event that generated the audit.
    • period

      protected Period period
      The period during which the activity occurred.
    • recorded

      protected InstantType recorded
      The time when the event was recorded.
    • outcome

      Indicates whether the event succeeded or failed.
    • outcomeDesc

      A free text description of the outcome of the event.
    • purposeOfEvent

      The purposeOfUse (reason) that was used during the event being recorded.
    • agent

      An actor taking an active role in the event or activity that is logged.
    • source

      The system that is reporting the event.
    • entity

      Specific instances of data or objects that have been accessed.
    • SP_DATE

      public static final String SP_DATE
      Search parameter: date

      Description: Time when the event was recorded
      Type: date
      Path: AuditEvent.recorded

      See Also:
    • DATE

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

      Description: Time when the event was recorded
      Type: date
      Path: AuditEvent.recorded

    • SP_ENTITY_TYPE

      public static final String SP_ENTITY_TYPE
      Search parameter: entity-type

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

      See Also:
    • ENTITY_TYPE

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

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

    • SP_AGENT

      public static final String SP_AGENT
      Search parameter: agent

      Description: Identifier of who
      Type: reference
      Path: AuditEvent.agent.who

      See Also:
    • AGENT

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

      Description: Identifier of who
      Type: reference
      Path: AuditEvent.agent.who

    • 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_ADDRESS

      public static final String SP_ADDRESS
      Search parameter: address

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

      See Also:
    • ADDRESS

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

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

    • SP_ENTITY_ROLE

      public static final String SP_ENTITY_ROLE
      Search parameter: entity-role

      Description: What role the entity played
      Type: token
      Path: AuditEvent.entity.role

      See Also:
    • ENTITY_ROLE

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

      Description: What role the entity played
      Type: token
      Path: AuditEvent.entity.role

    • SP_SOURCE

      public static final String SP_SOURCE
      Search parameter: source

      Description: The identity of source detecting the event
      Type: reference
      Path: AuditEvent.source.observer

      See Also:
    • SOURCE

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

      Description: The identity of source detecting the event
      Type: reference
      Path: AuditEvent.source.observer

    • INCLUDE_SOURCE

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

      public static final String SP_TYPE
      Search parameter: type

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

      See Also:
    • 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_ALTID

      public static final String SP_ALTID
      Search parameter: altid

      Description: Alternative User identity
      Type: token
      Path: AuditEvent.agent.altId

      See Also:
    • ALTID

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

      Description: Alternative User identity
      Type: token
      Path: AuditEvent.agent.altId

    • 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:
    • 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_AGENT_NAME

      public static final String SP_AGENT_NAME
      Search parameter: agent-name

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

      See Also:
    • AGENT_NAME

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

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

    • SP_ENTITY_NAME

      public static final String SP_ENTITY_NAME
      Search parameter: entity-name

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

      See Also:
    • 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

    • 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:
    • 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_PATIENT

      public static final String SP_PATIENT
      Search parameter: patient

      Description: Identifier of who
      Type: reference
      Path: AuditEvent.agent.who, AuditEvent.entity.what

      See Also:
    • PATIENT

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

      Description: Identifier of who
      Type: reference
      Path: AuditEvent.agent.who, AuditEvent.entity.what

    • 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_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:
    • 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_AGENT_ROLE

      public static final String SP_AGENT_ROLE
      Search parameter: agent-role

      Description: Agent role in the event
      Type: token
      Path: AuditEvent.agent.role

      See Also:
    • AGENT_ROLE

      public static final ca.uhn.fhir.rest.gclient.TokenClientParam AGENT_ROLE
      Fluent Client search parameter constant for agent-role

      Description: Agent role in the event
      Type: token
      Path: AuditEvent.agent.role

    • SP_ENTITY

      public static final String SP_ENTITY
      Search parameter: entity

      Description: Specific instance of resource
      Type: reference
      Path: AuditEvent.entity.what

      See Also:
    • ENTITY

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

      Description: Specific instance of resource
      Type: reference
      Path: AuditEvent.entity.what

    • 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".
    • SP_OUTCOME

      public static final String SP_OUTCOME
      Search parameter: outcome

      Description: Whether the event succeeded or failed
      Type: token
      Path: AuditEvent.outcome

      See Also:
    • OUTCOME

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

      Description: Whether the event succeeded or failed
      Type: token
      Path: AuditEvent.outcome

    • SP_POLICY

      public static final String SP_POLICY
      Search parameter: policy

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

      See Also:
    • 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

  • Constructor Details

  • Method Details