AuditEvent (HAPI FHIR Structures - DSTU2 (FHIR v1.0.0) 1.4 API)

java.lang.Object
- ca.uhn.fhir.model.api.BaseElement
- - ca.uhn.fhir.model.dstu2.resource.BaseResource
  - - ca.uhn.fhir.model.dstu2.resource.AuditEvent

All Implemented Interfaces:

ICompositeElement, IElement, IResource, ISupportsUndeclaredExtensions, Serializable, IBase, IBaseResource
```
public class AuditEvent
extends BaseResource
implements IResource
```
HAPI/FHIR AuditEvent Resource ()
Definition: 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

Requirements:

Profile Definition: http://hl7.org/fhir/profiles/AuditEvent

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`AuditEvent.Event` Block class for child element: AuditEvent.event ()
`static class`	`AuditEvent.ObjectDetail` Block class for child element: AuditEvent.object.detail ()
`static class`	`AuditEvent.ObjectElement` Block class for child element: AuditEvent.object ()
`static class`	`AuditEvent.Participant` Block class for child element: AuditEvent.participant ()
`static class`	`AuditEvent.ParticipantNetwork` Block class for child element: AuditEvent.participant.network ()
`static class`	`AuditEvent.Source` Block class for child element: AuditEvent.source ()

Field Summary

Fields
Modifier and Type	Field and Description
`static TokenClientParam`	`ACTION` Fluent Client search parameter constant for action
`static TokenClientParam`	`ADDRESS` Fluent Client search parameter constant for address
`static TokenClientParam`	`ALTID` Fluent Client search parameter constant for altid
`static DateClientParam`	`DATE` Fluent Client search parameter constant for date
`static StringClientParam`	`DESC` Fluent Client search parameter constant for desc
`static TokenClientParam`	`IDENTITY` Fluent Client search parameter constant for identity
`static Include`	`INCLUDE_PARTICIPANT` Constant for fluent queries to be used to add include statements.
`static Include`	`INCLUDE_PATIENT` Constant for fluent queries to be used to add include statements.
`static Include`	`INCLUDE_REFERENCE` Constant for fluent queries to be used to add include statements.
`static StringClientParam`	`NAME` Fluent Client search parameter constant for name
`static TokenClientParam`	`OBJECT_TYPE` Fluent Client search parameter constant for object-type
`static ReferenceClientParam`	`PARTICIPANT` Fluent Client search parameter constant for participant
`static ReferenceClientParam`	`PATIENT` Fluent Client search parameter constant for patient
`static UriClientParam`	`POLICY` Fluent Client search parameter constant for policy
`static ReferenceClientParam`	`REFERENCE` Fluent Client search parameter constant for reference
`static TokenClientParam`	`SITE` Fluent Client search parameter constant for site
`static TokenClientParam`	`SOURCE` Fluent Client search parameter constant for source
`static String`	`SP_ACTION` Search parameter constant for action
`static String`	`SP_ADDRESS` Search parameter constant for address
`static String`	`SP_ALTID` Search parameter constant for altid
`static String`	`SP_DATE` Search parameter constant for date
`static String`	`SP_DESC` Search parameter constant for desc
`static String`	`SP_IDENTITY` Search parameter constant for identity
`static String`	`SP_NAME` Search parameter constant for name
`static String`	`SP_OBJECT_TYPE` Search parameter constant for object-type
`static String`	`SP_PARTICIPANT` Search parameter constant for participant
`static String`	`SP_PATIENT` Search parameter constant for patient
`static String`	`SP_POLICY` Search parameter constant for policy
`static String`	`SP_REFERENCE` Search parameter constant for reference
`static String`	`SP_SITE` Search parameter constant for site
`static String`	`SP_SOURCE` Search parameter constant for source
`static String`	`SP_SUBTYPE` Search parameter constant for subtype
`static String`	`SP_TYPE` Search parameter constant for type
`static String`	`SP_USER` Search parameter constant for user
`static TokenClientParam`	`SUBTYPE` Fluent Client search parameter constant for subtype
`static TokenClientParam`	`TYPE` Fluent Client search parameter constant for type
`static TokenClientParam`	`USER` Fluent Client search parameter constant for user

Fields inherited from class ca.uhn.fhir.model.dstu2.resource.BaseResource
RES_ID, SP_RES_ID, SP_RES_LANGUAGE

Fields inherited from interface org.hl7.fhir.instance.model.api.IBaseResource
INCLUDE_ALL, WILDCARD_ALL_SET

Constructor Summary

Constructors
Constructor and Description

AuditEvent()

Constructors
Constructor and Description
`AuditEvent()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`AuditEvent.ObjectElement`	`addObject()` Adds and returns a new value for object ()
`AuditEvent`	`addObject(AuditEvent.ObjectElement theValue)` Adds a given new value for object ()
`AuditEvent.Participant`	`addParticipant()` Adds and returns a new value for participant ()
`AuditEvent`	`addParticipant(AuditEvent.Participant theValue)` Adds a given new value for participant ()
`<T extends IElement> List<T>`	`getAllPopulatedChildElementsOfType(Class<T> theType)`
`AuditEvent.Event`	`getEvent()` Gets the value(s) for event ().
`List<AuditEvent.ObjectElement>`	`getObject()` Gets the value(s) for object ().
`AuditEvent.ObjectElement`	`getObjectFirstRep()` Gets the first repetition for object (), creating it if it does not already exist.
`List<AuditEvent.Participant>`	`getParticipant()` Gets the value(s) for participant ().
`AuditEvent.Participant`	`getParticipantFirstRep()` Gets the first repetition for participant (), creating it if it does not already exist.
`String`	`getResourceName()`
`AuditEvent.Source`	`getSource()` Gets the value(s) for source ().
`FhirVersionEnum`	`getStructureFhirVersionEnum()`
`boolean`	`isEmpty()`
`AuditEvent`	`setEvent(AuditEvent.Event theValue)` Sets the value(s) for event ()
`AuditEvent`	`setObject(List<AuditEvent.ObjectElement> theValue)` Sets the value(s) for object ()
`AuditEvent`	`setParticipant(List<AuditEvent.Participant> theValue)` Sets the value(s) for participant ()
`AuditEvent`	`setSource(AuditEvent.Source theValue)` Sets the value(s) for source ()

Methods inherited from class ca.uhn.fhir.model.dstu2.resource.BaseResource
getContained, getId, getIdElement, getLanguage, getResourceMetadata, getText, isBaseEmpty, setContained, setId, setId, setId, setLanguage, setResourceMetadata, setText, toString

Methods inherited from class ca.uhn.fhir.model.api.BaseElement
addUndeclaredExtension, addUndeclaredExtension, addUndeclaredExtension, getAllUndeclaredExtensions, getUndeclaredExtensions, getUndeclaredExtensionsByUrl, getUndeclaredModifierExtensions

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface ca.uhn.fhir.model.api.IResource
getContained, getId, getLanguage, getResourceMetadata, getText, setId, setLanguage, setResourceMetadata

Methods inherited from interface org.hl7.fhir.instance.model.api.IBaseResource
getIdElement, setId, setId

- Field Detail
  - SP_TYPE
```
public static final String SP_TYPE
```
    Search parameter constant for type
    Description:
    Type: token
    Path: AuditEvent.event.type
    
    See Also:
    
    Constant Field Values
  - TYPE
```
public static final TokenClientParam TYPE
```
    Fluent Client search parameter constant for type
    Description:
    Type: token
    Path: AuditEvent.event.type
  - SP_ACTION
```
public static final String SP_ACTION
```
    Search parameter constant for action
    Description:
    Type: token
    Path: AuditEvent.event.action
    
    See Also:
    
    Constant Field Values
  - ACTION
```
public static final TokenClientParam ACTION
```
    Fluent Client search parameter constant for action
    Description:
    Type: token
    Path: AuditEvent.event.action
  - SP_DATE
```
public static final String SP_DATE
```
    Search parameter constant for date
    Description:
    Type: date
    Path: AuditEvent.event.dateTime
    
    See Also:
    
    Constant Field Values
  - DATE
```
public static final DateClientParam DATE
```
    Fluent Client search parameter constant for date
    Description:
    Type: date
    Path: AuditEvent.event.dateTime
  - SP_SUBTYPE
```
public static final String SP_SUBTYPE
```
    Search parameter constant for subtype
    Description:
    Type: token
    Path: AuditEvent.event.subtype
    
    See Also:
    
    Constant Field Values
  - SUBTYPE
```
public static final TokenClientParam SUBTYPE
```
    Fluent Client search parameter constant for subtype
    Description:
    Type: token
    Path: AuditEvent.event.subtype
  - SP_USER
```
public static final String SP_USER
```
    Search parameter constant for user
    Description:
    Type: token
    Path: AuditEvent.participant.userId
    
    See Also:
    
    Constant Field Values
  - USER
```
public static final TokenClientParam USER
```
    Fluent Client search parameter constant for user
    Description:
    Type: token
    Path: AuditEvent.participant.userId
  - SP_NAME
```
public static final String SP_NAME
```
    Search parameter constant for name
    Description:
    Type: string
    Path: AuditEvent.participant.name
    
    See Also:
    
    Constant Field Values
  - NAME
```
public static final StringClientParam NAME
```
    Fluent Client search parameter constant for name
    Description:
    Type: string
    Path: AuditEvent.participant.name
  - SP_ADDRESS
```
public static final String SP_ADDRESS
```
    Search parameter constant for address
    Description:
    Type: token
    Path: AuditEvent.participant.network.address
    
    See Also:
    
    Constant Field Values
  - ADDRESS
```
public static final TokenClientParam ADDRESS
```
    Fluent Client search parameter constant for address
    Description:
    Type: token
    Path: AuditEvent.participant.network.address
  - SP_SOURCE
```
public static final String SP_SOURCE
```
    Search parameter constant for source
    Description:
    Type: token
    Path: AuditEvent.source.identifier
    
    See Also:
    
    Constant Field Values
  - SOURCE
```
public static final TokenClientParam SOURCE
```
    Fluent Client search parameter constant for source
    Description:
    Type: token
    Path: AuditEvent.source.identifier
  - SP_SITE
```
public static final String SP_SITE
```
    Search parameter constant for site
    Description:
    Type: token
    Path: AuditEvent.source.site
    
    See Also:
    
    Constant Field Values
  - SITE
```
public static final TokenClientParam SITE
```
    Fluent Client search parameter constant for site
    Description:
    Type: token
    Path: AuditEvent.source.site
  - SP_OBJECT_TYPE
```
public static final String SP_OBJECT_TYPE
```
    Search parameter constant for object-type
    Description:
    Type: token
    Path: AuditEvent.object.type
    
    See Also:
    
    Constant Field Values
  - OBJECT_TYPE
```
public static final TokenClientParam OBJECT_TYPE
```
    Fluent Client search parameter constant for object-type
    Description:
    Type: token
    Path: AuditEvent.object.type
  - SP_IDENTITY
```
public static final String SP_IDENTITY
```
    Search parameter constant for identity
    Description:
    Type: token
    Path: AuditEvent.object.identifier
    
    See Also:
    
    Constant Field Values
  - IDENTITY
```
public static final TokenClientParam IDENTITY
```
    Fluent Client search parameter constant for identity
    Description:
    Type: token
    Path: AuditEvent.object.identifier
  - SP_REFERENCE
```
public static final String SP_REFERENCE
```
    Search parameter constant for reference
    Description:
    Type: reference
    Path: AuditEvent.object.reference
    
    See Also:
    
    Constant Field Values
  - REFERENCE
```
public static final ReferenceClientParam REFERENCE
```
    Fluent Client search parameter constant for reference
    Description:
    Type: reference
    Path: AuditEvent.object.reference
  - SP_DESC
```
public static final String SP_DESC
```
    Search parameter constant for desc
    Description:
    Type: string
    Path: AuditEvent.object.name
    
    See Also:
    
    Constant Field Values
  - DESC
```
public static final StringClientParam DESC
```
    Fluent Client search parameter constant for desc
    Description:
    Type: string
    Path: AuditEvent.object.name
  - SP_PATIENT
```
public static final String SP_PATIENT
```
    Search parameter constant for patient
    Description:
    Type: reference
    Path: AuditEvent.participant.reference | AuditEvent.object.reference
    
    See Also:
    
    Constant Field Values
  - PATIENT
```
public static final ReferenceClientParam PATIENT
```
    Fluent Client search parameter constant for patient
    Description:
    Type: reference
    Path: AuditEvent.participant.reference | AuditEvent.object.reference
  - SP_ALTID
```
public static final String SP_ALTID
```
    Search parameter constant for altid
    Description:
    Type: token
    Path: AuditEvent.participant.altId
    
    See Also:
    
    Constant Field Values
  - ALTID
```
public static final TokenClientParam ALTID
```
    Fluent Client search parameter constant for altid
    Description:
    Type: token
    Path: AuditEvent.participant.altId
  - SP_PARTICIPANT
```
public static final String SP_PARTICIPANT
```
    Search parameter constant for participant
    Description:
    Type: reference
    Path: AuditEvent.participant.reference
    
    See Also:
    
    Constant Field Values
  - PARTICIPANT
```
public static final ReferenceClientParam PARTICIPANT
```
    Fluent Client search parameter constant for participant
    Description:
    Type: reference
    Path: AuditEvent.participant.reference
  - SP_POLICY
```
public static final String SP_POLICY
```
    Search parameter constant for policy
    Description:
    Type: uri
    Path: AuditEvent.participant.policy
    
    See Also:
    
    Constant Field Values
  - POLICY
```
public static final UriClientParam POLICY
```
    Fluent Client search parameter constant for policy
    Description:
    Type: uri
    Path: AuditEvent.participant.policy
  - INCLUDE_PARTICIPANT
```
public static final Include INCLUDE_PARTICIPANT
```
    Constant for fluent queries to be used to add include statements. Specifies the path value of "AuditEvent:participant".
  - INCLUDE_PATIENT
```
public static final Include INCLUDE_PATIENT
```
    Constant for fluent queries to be used to add include statements. Specifies the path value of "AuditEvent:patient".
  - INCLUDE_REFERENCE
```
public static final Include INCLUDE_REFERENCE
```
    Constant for fluent queries to be used to add include statements. Specifies the path value of "AuditEvent:reference".
- Constructor Detail
  - AuditEvent
```
public AuditEvent()
```
- Method Detail
  - isEmpty
```
public boolean isEmpty()
```
    Specified by:
    
    isEmpty in interface IBase
  - getAllPopulatedChildElementsOfType
```
public <T extends IElement> List<T> getAllPopulatedChildElementsOfType(Class<T> theType)
```
    Specified by:
    
    getAllPopulatedChildElementsOfType in interface ICompositeElement
  - getEvent
```
public AuditEvent.Event getEvent()
```
    Gets the value(s) for event (). creating it if it does not exist. Will not return null.
    Definition: Identifies the name, action type, time, and disposition of the audited event
  - setEvent
```
public AuditEvent setEvent(AuditEvent.Event theValue)
```
    Sets the value(s) for event ()
    Definition: Identifies the name, action type, time, and disposition of the audited event
  - getParticipant
```
public List<AuditEvent.Participant> getParticipant()
```
    Gets the value(s) for participant (). creating it if it does not exist. Will not return null.
    Definition:
  - setParticipant
```
public AuditEvent setParticipant(List<AuditEvent.Participant> theValue)
```
    Sets the value(s) for participant ()
    Definition:
  - addParticipant
```
public AuditEvent.Participant addParticipant()
```
    Adds and returns a new value for participant ()
    Definition:
  - addParticipant
```
public AuditEvent addParticipant(AuditEvent.Participant theValue)
```
    Adds a given new value for participant ()
    Definition:
    
    Parameters:
    
    theValue - The participant to add (must not be null)
  - getParticipantFirstRep
```
public AuditEvent.Participant getParticipantFirstRep()
```
    Gets the first repetition for participant (), creating it if it does not already exist.
    Definition:
  - getSource
```
public AuditEvent.Source getSource()
```
    Gets the value(s) for source (). creating it if it does not exist. Will not return null.
    Definition:
  - setSource
```
public AuditEvent setSource(AuditEvent.Source theValue)
```
    Sets the value(s) for source ()
    Definition:
  - getObject
```
public List<AuditEvent.ObjectElement> getObject()
```
    Gets the value(s) for object (). creating it if it does not exist. Will not return null.
    Definition: Specific instances of data or objects that have been accessed
  - setObject
```
public AuditEvent setObject(List<AuditEvent.ObjectElement> theValue)
```
    Sets the value(s) for object ()
    Definition: Specific instances of data or objects that have been accessed
  - addObject
```
public AuditEvent.ObjectElement addObject()
```
    Adds and returns a new value for object ()
    Definition: Specific instances of data or objects that have been accessed
  - addObject
```
public AuditEvent addObject(AuditEvent.ObjectElement theValue)
```
    Adds a given new value for object ()
    Definition: Specific instances of data or objects that have been accessed
    
    Parameters:
    
    theValue - The object to add (must not be null)
  - getObjectFirstRep
```
public AuditEvent.ObjectElement getObjectFirstRep()
```
    Gets the first repetition for object (), creating it if it does not already exist.
    Definition: Specific instances of data or objects that have been accessed
  - getResourceName
```
public String getResourceName()
```
    Specified by:
    
    getResourceName in interface IResource
  - getStructureFhirVersionEnum
```
public FhirVersionEnum getStructureFhirVersionEnum()
```
    Specified by:
    
    getStructureFhirVersionEnum in interface IResource
    
    Specified by:
    
    getStructureFhirVersionEnum in interface IBaseResource

Class AuditEvent

Nested Class Summary

Field Summary

Fields inherited from class ca.uhn.fhir.model.dstu2.resource.BaseResource

Fields inherited from interface org.hl7.fhir.instance.model.api.IBaseResource

Constructor Summary

Method Summary

Methods inherited from class ca.uhn.fhir.model.dstu2.resource.BaseResource

Methods inherited from class ca.uhn.fhir.model.api.BaseElement

Methods inherited from class java.lang.Object

Methods inherited from interface ca.uhn.fhir.model.api.IResource

Methods inherited from interface org.hl7.fhir.instance.model.api.IBaseResource

Field Detail

SP_TYPE

TYPE

SP_ACTION

ACTION

SP_DATE

DATE

SP_SUBTYPE

SUBTYPE

SP_USER

USER

SP_NAME

NAME

SP_ADDRESS

ADDRESS

SP_SOURCE

SOURCE

SP_SITE

SITE

SP_OBJECT_TYPE

OBJECT_TYPE

SP_IDENTITY

IDENTITY

SP_REFERENCE

REFERENCE

SP_DESC

DESC

SP_PATIENT

PATIENT

SP_ALTID

ALTID

SP_PARTICIPANT

PARTICIPANT

SP_POLICY

POLICY

INCLUDE_PARTICIPANT

INCLUDE_PATIENT

INCLUDE_REFERENCE

Constructor Detail

AuditEvent

Method Detail

isEmpty

getAllPopulatedChildElementsOfType

getEvent

setEvent

getParticipant

setParticipant

addParticipant

addParticipant

getParticipantFirstRep

getSource

setSource

getObject

setObject

addObject

addObject

getObjectFirstRep

getResourceName

getStructureFhirVersionEnum