java.lang.Object
- org.hl7.fhir.dstu2016may.model.Base
- - org.hl7.fhir.dstu2016may.model.Element
  - - org.hl7.fhir.dstu2016may.model.BackboneElement
    - - org.hl7.fhir.dstu2016may.model.AuditEvent.AuditEventAgentComponent

All Implemented Interfaces:

ca.uhn.fhir.model.api.IElement, Serializable, org.hl7.fhir.instance.model.api.IBase, org.hl7.fhir.instance.model.api.IBaseBackboneElement, org.hl7.fhir.instance.model.api.IBaseElement, org.hl7.fhir.instance.model.api.IBaseHasExtensions, org.hl7.fhir.instance.model.api.IBaseHasModifierExtensions

Enclosing class:

AuditEvent
```
public static class AuditEvent.AuditEventAgentComponent
extends BackboneElement
implements org.hl7.fhir.instance.model.api.IBaseBackboneElement
```
See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field	Description
`protected StringType`	`altId`	Alternative agent Identifier.
`protected Reference`	`location`	Where the event occurred.
`protected Location`	`locationTarget`	The actual object that is the target of the reference (Where the event occurred.)
`protected Coding`	`media`	Type of media involved.
`protected StringType`	`name`	Human-meaningful name for the agent.
`protected AuditEvent.AuditEventAgentNetworkComponent`	`network`	Logical network location for application activity, if the activity has a network location.
`protected List<UriType>`	`policy`	The policy or plan that authorized the activity being recorded.
`protected List<Coding>`	`purposeOfUse`	The reason (purpose of use), specific to this agent, that was used during the event being recorded.
`protected Reference`	`reference`	Direct reference to a resource that identifies the agent.
`protected Resource`	`referenceTarget`	The actual object that is the target of the reference (Direct reference to a resource that identifies the agent.)
`protected BooleanType`	`requestor`	Indicator that the user is or is not the requestor, or initiator, for the event being audited.
`protected List<CodeableConcept>`	`role`	Specification of the role(s) the user plays when performing the event.
`protected Identifier`	`userId`	Unique identifier for the user actively participating in the event.

Fields inherited from class org.hl7.fhir.dstu2016may.model.BackboneElement
modifierExtension

Fields inherited from class org.hl7.fhir.dstu2016may.model.Element
extension, id

Constructor Summary

Constructors
Constructor Description

AuditEventAgentComponent()
Constructor

AuditEventAgentComponent(BooleanType requestor)
Constructor

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`Base`	`addChild(String name)`
`AuditEvent.AuditEventAgentComponent`	`addPolicy(String value)`
`UriType`	`addPolicyElement()`
`Coding`	`addPurposeOfUse()`
`AuditEvent.AuditEventAgentComponent`	`addPurposeOfUse(Coding t)`
`CodeableConcept`	`addRole()`
`AuditEvent.AuditEventAgentComponent`	`addRole(CodeableConcept t)`
`AuditEvent.AuditEventAgentComponent`	`copy()`
`boolean`	`equalsDeep(Base other)`
`boolean`	`equalsShallow(Base other)`
`String`	`fhirType()`
`String`	`getAltId()`
`StringType`	`getAltIdElement()`
`Reference`	`getLocation()`
`Location`	`getLocationTarget()`
`Coding`	`getMedia()`
`String`	`getName()`
`StringType`	`getNameElement()`
`AuditEvent.AuditEventAgentNetworkComponent`	`getNetwork()`
`List<UriType>`	`getPolicy()`
`Base[]`	`getProperty(int hash, String name, boolean checkValid)`
`List<Coding>`	`getPurposeOfUse()`
`Reference`	`getReference()`
`Resource`	`getReferenceTarget()`
`boolean`	`getRequestor()`
`BooleanType`	`getRequestorElement()`
`List<CodeableConcept>`	`getRole()`
`Identifier`	`getUserId()`
`boolean`	`hasAltId()`
`boolean`	`hasAltIdElement()`
`boolean`	`hasLocation()`
`boolean`	`hasMedia()`
`boolean`	`hasName()`
`boolean`	`hasNameElement()`
`boolean`	`hasNetwork()`
`boolean`	`hasPolicy()`
`boolean`	`hasPolicy(String value)`
`boolean`	`hasPurposeOfUse()`
`boolean`	`hasReference()`
`boolean`	`hasRequestor()`
`boolean`	`hasRequestorElement()`
`boolean`	`hasRole()`
`boolean`	`hasUserId()`
`boolean`	`isEmpty()`
`protected void`	`listChildren(List<Property> childrenList)`
`Base`	`makeProperty(int hash, String name)`	make an instance of a property.
`AuditEvent.AuditEventAgentComponent`	`setAltId(String value)`
`AuditEvent.AuditEventAgentComponent`	`setAltIdElement(StringType value)`
`AuditEvent.AuditEventAgentComponent`	`setLocation(Reference value)`
`AuditEvent.AuditEventAgentComponent`	`setLocationTarget(Location value)`
`AuditEvent.AuditEventAgentComponent`	`setMedia(Coding value)`
`AuditEvent.AuditEventAgentComponent`	`setName(String value)`
`AuditEvent.AuditEventAgentComponent`	`setNameElement(StringType value)`
`AuditEvent.AuditEventAgentComponent`	`setNetwork(AuditEvent.AuditEventAgentNetworkComponent value)`
`void`	`setProperty(int hash, String name, Base value)`
`void`	`setProperty(String name, Base value)`
`AuditEvent.AuditEventAgentComponent`	`setReference(Reference value)`
`AuditEvent.AuditEventAgentComponent`	`setReferenceTarget(Resource value)`
`AuditEvent.AuditEventAgentComponent`	`setRequestor(boolean value)`
`AuditEvent.AuditEventAgentComponent`	`setRequestorElement(BooleanType value)`
`AuditEvent.AuditEventAgentComponent`	`setUserId(Identifier value)`

Methods inherited from class org.hl7.fhir.dstu2016may.model.BackboneElement
addModifierExtension, addModifierExtension, copyValues, getModifierExtension, hasModifierExtension

Methods inherited from class org.hl7.fhir.dstu2016may.model.Element
addExtension, addExtension, copyValues, getExtension, getExtensionsByUrl, getExtensionString, getId, getIdElement, hasExtension, hasExtension, hasId, hasIdElement, setId, setIdElement

Methods inherited from class org.hl7.fhir.dstu2016may.model.Base
castToActionDefinition, castToAddress, castToAnnotation, castToAttachment, castToBase64Binary, castToBoolean, castToCode, castToCodeableConcept, castToCoding, castToContactPoint, castToDataRequirement, castToDate, castToDateTime, castToDecimal, castToDuration, castToElementDefinition, castToExtension, castToHumanName, castToId, castToIdentifier, castToInstant, castToInteger, castToMarkdown, castToMeta, castToModuleMetadata, castToMoney, castToNarrative, castToOid, castToParameterDefinition, castToPeriod, castToPositiveInt, castToQuantity, castToRange, castToRatio, castToReference, castToResource, castToSampledData, castToSignature, castToSimpleQuantity, castToString, castToTime, castToTiming, castToTriggerDefinition, castToUnsignedInt, castToUri, children, compareDeep, compareDeep, compareDeep, compareValues, compareValues, equals, getChildByName, getFormatCommentsPost, getFormatCommentsPre, getUserData, getUserInt, getUserString, hasFormatComment, hasPrimitiveValue, hasType, hasUserData, isMetadataBased, isPrimitive, listChildrenByName, listChildrenByName, primitiveValue, setUserData, setUserDataINN

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

Methods inherited from interface org.hl7.fhir.instance.model.api.IBase
getFormatCommentsPost, getFormatCommentsPre, getUserData, hasFormatComment, setUserData

Methods inherited from interface org.hl7.fhir.instance.model.api.IBaseElement
getUserData, setUserData

Methods inherited from interface org.hl7.fhir.instance.model.api.IBaseHasExtensions
addExtension, getExtension, hasExtension

Methods inherited from interface org.hl7.fhir.instance.model.api.IBaseHasModifierExtensions
addModifierExtension, getModifierExtension, hasModifierExtension

- Field Detail
  - role
```
protected List<CodeableConcept> role
```
    Specification of the role(s) the user plays when performing the event. Usually the codes used in this element are local codes defined by the access control security system (e.g. RBAC, ABAC) used in the local context.
  - reference
```
protected Reference reference
```
    Direct reference to a resource that identifies the agent.
  - referenceTarget
```
protected Resource referenceTarget
```
    The actual object that is the target of the reference (Direct reference to a resource that identifies the agent.)
  - userId
```
protected Identifier userId
```
    Unique identifier for the user actively participating in the event.
  - altId
```
protected StringType altId
```
    Alternative agent Identifier. For a human, this should be a user identifier text string from authentication system. This identifier would be one known to a common authentication system (e.g. single sign-on), if available.
  - name
```
protected StringType name
```
    Human-meaningful name for the agent.
  - requestor
```
protected BooleanType requestor
```
    Indicator that the user is or is not the requestor, or initiator, for the event being audited.
  - location
```
protected Reference location
```
    Where the event occurred.
  - locationTarget
```
protected Location locationTarget
```
    The actual object that is the target of the reference (Where the event occurred.)
  - policy
```
protected List<UriType> policy
```
    The policy or plan that authorized the activity being recorded. Typically, a single activity may have multiple applicable policies, such as patient consent, guarantor funding, etc. The policy would also indicate the security token used.
  - media
```
protected Coding media
```
    Type of media involved. Used when the event is about exporting/importing onto media.
  - network
```
protected AuditEvent.AuditEventAgentNetworkComponent network
```
    Logical network location for application activity, if the activity has a network location.
  - purposeOfUse
```
protected List<Coding> purposeOfUse
```
    The reason (purpose of use), specific to this agent, that was used during the event being recorded.
- Constructor Detail
  - AuditEventAgentComponent
```
public AuditEventAgentComponent()
```
    Constructor
  - AuditEventAgentComponent
```
public AuditEventAgentComponent(BooleanType requestor)
```
    Constructor
- Method Detail
  - getRole
```
public List<CodeableConcept> getRole()
```
    Returns:
    
    role (Specification of the role(s) the user plays when performing the event. Usually the codes used in this element are local codes defined by the access control security system (e.g. RBAC, ABAC) used in the local context.)
  - hasRole
```
public boolean hasRole()
```
  - addRole
```
public CodeableConcept addRole()
```
    Returns:
    
    role (Specification of the role(s) the user plays when performing the event. Usually the codes used in this element are local codes defined by the access control security system (e.g. RBAC, ABAC) used in the local context.)
  - addRole
```
public AuditEvent.AuditEventAgentComponent addRole(CodeableConcept t)
```
  - getReference
```
public Reference getReference()
```
    Returns:
    
    reference (Direct reference to a resource that identifies the agent.)
  - hasReference
```
public boolean hasReference()
```
  - setReference
```
public AuditEvent.AuditEventAgentComponent setReference(Reference value)
```
    Parameters:
    
    value - reference (Direct reference to a resource that identifies the agent.)
  - getReferenceTarget
```
public Resource getReferenceTarget()
```
    Returns:
    
    reference The actual object that is the target of the reference. The reference library doesn't populate this, but you can use it to hold the resource if you resolve it. (Direct reference to a resource that identifies the agent.)
  - setReferenceTarget
```
public AuditEvent.AuditEventAgentComponent setReferenceTarget(Resource value)
```
    Parameters:
    
    value - reference The actual object that is the target of the reference. The reference library doesn't use these, but you can use it to hold the resource if you resolve it. (Direct reference to a resource that identifies the agent.)
  - getUserId
```
public Identifier getUserId()
```
    Returns:
    
    userId (Unique identifier for the user actively participating in the event.)
  - hasUserId
```
public boolean hasUserId()
```
  - setUserId
```
public AuditEvent.AuditEventAgentComponent setUserId(Identifier value)
```
    Parameters:
    
    value - userId (Unique identifier for the user actively participating in the event.)
  - getAltIdElement
```
public StringType getAltIdElement()
```
    Returns:
    
    altId (Alternative agent Identifier. For a human, this should be a user identifier text string from authentication system. This identifier would be one known to a common authentication system (e.g. single sign-on), if available.). This is the underlying object with id, value and extensions. The accessor "getAltId" gives direct access to the value
  - hasAltIdElement
```
public boolean hasAltIdElement()
```
  - hasAltId
```
public boolean hasAltId()
```
  - setAltIdElement
```
public AuditEvent.AuditEventAgentComponent setAltIdElement(StringType value)
```
    Parameters:
    
    value - altId (Alternative agent Identifier. For a human, this should be a user identifier text string from authentication system. This identifier would be one known to a common authentication system (e.g. single sign-on), if available.). This is the underlying object with id, value and extensions. The accessor "getAltId" gives direct access to the value
  - getAltId
```
public String getAltId()
```
    Returns:
    
    Alternative agent Identifier. For a human, this should be a user identifier text string from authentication system. This identifier would be one known to a common authentication system (e.g. single sign-on), if available.
  - setAltId
```
public AuditEvent.AuditEventAgentComponent setAltId(String value)
```
    Parameters:
    
    value - Alternative agent Identifier. For a human, this should be a user identifier text string from authentication system. This identifier would be one known to a common authentication system (e.g. single sign-on), if available.
  - getNameElement
```
public StringType getNameElement()
```
    Returns:
    
    name (Human-meaningful name for the agent.). This is the underlying object with id, value and extensions. The accessor "getName" gives direct access to the value
  - hasNameElement
```
public boolean hasNameElement()
```
  - hasName
```
public boolean hasName()
```
  - setNameElement
```
public AuditEvent.AuditEventAgentComponent setNameElement(StringType value)
```
    Parameters:
    
    value - name (Human-meaningful name for the agent.). This is the underlying object with id, value and extensions. The accessor "getName" gives direct access to the value
  - getName
```
public String getName()
```
    Returns:
    
    Human-meaningful name for the agent.
  - setName
```
public AuditEvent.AuditEventAgentComponent setName(String value)
```
    Parameters:
    
    value - Human-meaningful name for the agent.
  - getRequestorElement
```
public BooleanType getRequestorElement()
```
    Returns:
    
    requestor (Indicator that the user is or is not the requestor, or initiator, for the event being audited.). This is the underlying object with id, value and extensions. The accessor "getRequestor" gives direct access to the value
  - hasRequestorElement
```
public boolean hasRequestorElement()
```
  - hasRequestor
```
public boolean hasRequestor()
```
  - setRequestorElement
```
public AuditEvent.AuditEventAgentComponent setRequestorElement(BooleanType value)
```
    Parameters:
    
    value - requestor (Indicator that the user is or is not the requestor, or initiator, for the event being audited.). This is the underlying object with id, value and extensions. The accessor "getRequestor" gives direct access to the value
  - getRequestor
```
public boolean getRequestor()
```
    Returns:
    
    Indicator that the user is or is not the requestor, or initiator, for the event being audited.
  - setRequestor
```
public AuditEvent.AuditEventAgentComponent setRequestor(boolean value)
```
    Parameters:
    
    value - Indicator that the user is or is not the requestor, or initiator, for the event being audited.
  - getLocation
```
public Reference getLocation()
```
    Returns:
    
    location (Where the event occurred.)
  - hasLocation
```
public boolean hasLocation()
```
  - setLocation
```
public AuditEvent.AuditEventAgentComponent setLocation(Reference value)
```
    Parameters:
    
    value - location (Where the event occurred.)
  - getLocationTarget
```
public Location getLocationTarget()
```
    Returns:
    
    location The actual object that is the target of the reference. The reference library doesn't populate this, but you can use it to hold the resource if you resolve it. (Where the event occurred.)
  - setLocationTarget
```
public AuditEvent.AuditEventAgentComponent setLocationTarget(Location value)
```
    Parameters:
    
    value - location The actual object that is the target of the reference. The reference library doesn't use these, but you can use it to hold the resource if you resolve it. (Where the event occurred.)
  - getPolicy
```
public List<UriType> getPolicy()
```
    Returns:
    
    policy (The policy or plan that authorized the activity being recorded. Typically, a single activity may have multiple applicable policies, such as patient consent, guarantor funding, etc. The policy would also indicate the security token used.)
  - hasPolicy
```
public boolean hasPolicy()
```
  - addPolicyElement
```
public UriType addPolicyElement()
```
    Returns:
    
    policy (The policy or plan that authorized the activity being recorded. Typically, a single activity may have multiple applicable policies, such as patient consent, guarantor funding, etc. The policy would also indicate the security token used.)
  - addPolicy
```
public AuditEvent.AuditEventAgentComponent addPolicy(String value)
```
    Parameters:
    
    value - policy (The policy or plan that authorized the activity being recorded. Typically, a single activity may have multiple applicable policies, such as patient consent, guarantor funding, etc. The policy would also indicate the security token used.)
  - hasPolicy
```
public boolean hasPolicy(String value)
```
    Parameters:
    
    value - policy (The policy or plan that authorized the activity being recorded. Typically, a single activity may have multiple applicable policies, such as patient consent, guarantor funding, etc. The policy would also indicate the security token used.)
  - getMedia
```
public Coding getMedia()
```
    Returns:
    
    media (Type of media involved. Used when the event is about exporting/importing onto media.)
  - hasMedia
```
public boolean hasMedia()
```
  - setMedia
```
public AuditEvent.AuditEventAgentComponent setMedia(Coding value)
```
    Parameters:
    
    value - media (Type of media involved. Used when the event is about exporting/importing onto media.)
  - getNetwork
```
public AuditEvent.AuditEventAgentNetworkComponent getNetwork()
```
    Returns:
    
    network (Logical network location for application activity, if the activity has a network location.)
  - hasNetwork
```
public boolean hasNetwork()
```
  - setNetwork
```
public AuditEvent.AuditEventAgentComponent setNetwork(AuditEvent.AuditEventAgentNetworkComponent value)
```
    Parameters:
    
    value - network (Logical network location for application activity, if the activity has a network location.)
  - getPurposeOfUse
```
public List<Coding> getPurposeOfUse()
```
    Returns:
    
    purposeOfUse (The reason (purpose of use), specific to this agent, that was used during the event being recorded.)
  - hasPurposeOfUse
```
public boolean hasPurposeOfUse()
```
  - addPurposeOfUse
```
public Coding addPurposeOfUse()
```
    Returns:
    
    purposeOfUse (The reason (purpose of use), specific to this agent, that was used during the event being recorded.)
  - addPurposeOfUse
```
public AuditEvent.AuditEventAgentComponent addPurposeOfUse(Coding t)
```
  - listChildren
```
protected void listChildren(List<Property> childrenList)
```
    Overrides:
    
    listChildren in class BackboneElement
  - getProperty
```
public Base[] getProperty(int hash,
                          String name,
                          boolean checkValid)
                   throws org.hl7.fhir.exceptions.FHIRException
```
    Overrides:
    
    getProperty in class BackboneElement
    
    Throws:
    
    org.hl7.fhir.exceptions.FHIRException
  - setProperty
```
public void setProperty(int hash,
                        String name,
                        Base value)
                 throws org.hl7.fhir.exceptions.FHIRException
```
    Overrides:
    
    setProperty in class BackboneElement
    
    Throws:
    
    org.hl7.fhir.exceptions.FHIRException
  - setProperty
```
public void setProperty(String name,
                        Base value)
                 throws org.hl7.fhir.exceptions.FHIRException
```
    Overrides:
    
    setProperty in class BackboneElement
    
    Throws:
    
    org.hl7.fhir.exceptions.FHIRException
  - makeProperty
```
public Base makeProperty(int hash,
                         String name)
                  throws org.hl7.fhir.exceptions.FHIRException
```
    Description copied from class: Base
    
    make an instance of a property. If the property is a repeating property, make a new instance. if the property is not repeating, return the property
    
    Overrides:
    
    makeProperty in class BackboneElement
    
    Returns:
    
    Throws:
    
    org.hl7.fhir.exceptions.FHIRException
  - addChild
```
public Base addChild(String name)
              throws org.hl7.fhir.exceptions.FHIRException
```
    Overrides:
    
    addChild in class BackboneElement
    
    Throws:
    
    org.hl7.fhir.exceptions.FHIRException
  - copy
```
public AuditEvent.AuditEventAgentComponent copy()
```
    Specified by:
    
    copy in class BackboneElement
  - equalsDeep
```
public boolean equalsDeep(Base other)
```
    Overrides:
    
    equalsDeep in class BackboneElement
  - equalsShallow
```
public boolean equalsShallow(Base other)
```
    Overrides:
    
    equalsShallow in class BackboneElement
  - isEmpty
```
public boolean isEmpty()
```
    Specified by:
    
    isEmpty in interface org.hl7.fhir.instance.model.api.IBase
    
    Overrides:
    
    isEmpty in class BackboneElement
  - fhirType
```
public String fhirType()
```
    Specified by:
    
    fhirType in interface org.hl7.fhir.instance.model.api.IBase
    
    Overrides:
    
    fhirType in class BackboneElement

Constructor	Description
`AuditEventAgentComponent()`	Constructor
`AuditEventAgentComponent(BooleanType requestor)`	Constructor

Class AuditEvent.AuditEventAgentComponent

Field Summary

Fields inherited from class org.hl7.fhir.dstu2016may.model.BackboneElement

Fields inherited from class org.hl7.fhir.dstu2016may.model.Element

Constructor Summary

Method Summary

Methods inherited from class org.hl7.fhir.dstu2016may.model.BackboneElement

Methods inherited from class org.hl7.fhir.dstu2016may.model.Element

Methods inherited from class org.hl7.fhir.dstu2016may.model.Base

Methods inherited from class java.lang.Object

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

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

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

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

Field Detail

role

reference

referenceTarget

userId

altId

name

requestor

location

locationTarget

policy

media

network

purposeOfUse

Constructor Detail

AuditEventAgentComponent

AuditEventAgentComponent

Method Detail

getRole

hasRole

addRole

addRole

getReference

hasReference

setReference

getReferenceTarget

setReferenceTarget

getUserId

hasUserId

setUserId

getAltIdElement

hasAltIdElement

hasAltId

setAltIdElement

getAltId

setAltId

getNameElement

hasNameElement

hasName

setNameElement

getName

setName

getRequestorElement

hasRequestorElement

hasRequestor

setRequestorElement

getRequestor

setRequestor

getLocation

hasLocation

setLocation

getLocationTarget

setLocationTarget

getPolicy

hasPolicy

addPolicyElement

addPolicy

hasPolicy

getMedia

hasMedia

setMedia

getNetwork

hasNetwork

setNetwork

getPurposeOfUse

hasPurposeOfUse