Class AuditEvent.Agent
- java.lang.Object
-
- org.linuxforhealth.fhir.model.visitor.AbstractVisitable
-
- org.linuxforhealth.fhir.model.type.Element
-
- org.linuxforhealth.fhir.model.type.BackboneElement
-
- org.linuxforhealth.fhir.model.resource.AuditEvent.Agent
-
- All Implemented Interfaces:
Visitable
- Enclosing class:
- AuditEvent
public static class AuditEvent.Agent extends BackboneElement
An actor taking an active role in the event or activity that is logged.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
AuditEvent.Agent.Builder
static class
AuditEvent.Agent.Network
Logical network location for application activity, if the activity has a network location.
-
Field Summary
-
Fields inherited from class org.linuxforhealth.fhir.model.type.BackboneElement
modifierExtension
-
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description void
accept(java.lang.String elementName, int elementIndex, Visitor visitor)
Accept a Visitor and invoke the appropriate visit methods.static AuditEvent.Agent.Builder
builder()
boolean
equals(java.lang.Object obj)
String
getAltId()
Alternative agent Identifier.Reference
getLocation()
Where the event occurred.Coding
getMedia()
Type of media involved.String
getName()
Human-meaningful name for the agent.AuditEvent.Agent.Network
getNetwork()
Logical network location for application activity, if the activity has a network location.java.util.List<Uri>
getPolicy()
The policy or plan that authorized the activity being recorded.java.util.List<CodeableConcept>
getPurposeOfUse()
The reason (purpose of use), specific to this agent, that was used during the event being recorded.Boolean
getRequestor()
Indicator that the user is or is not the requestor, or initiator, for the event being audited.java.util.List<CodeableConcept>
getRole()
The security role that the user was acting under, that come from local codes defined by the access control security system (e.g.CodeableConcept
getType()
Specification of the participation type the user plays when performing the event.Reference
getWho()
Reference to who this agent is that was involved in the event.boolean
hasChildren()
int
hashCode()
AuditEvent.Agent.Builder
toBuilder()
Create a new Builder from the contents of this Element-
Methods inherited from class org.linuxforhealth.fhir.model.type.BackboneElement
getModifierExtension
-
Methods inherited from class org.linuxforhealth.fhir.model.type.Element
as, getExtension, getId, hasValue, is
-
-
-
-
Method Detail
-
getType
public CodeableConcept getType()
Specification of the participation type the user plays when performing the event.- Returns:
- An immutable object of type
CodeableConcept
that may be null.
-
getRole
public java.util.List<CodeableConcept> getRole()
The security role that the user was acting under, that come from local codes defined by the access control security system (e.g. RBAC, ABAC) used in the local context.- Returns:
- An unmodifiable list containing immutable objects of type
CodeableConcept
that may be empty.
-
getWho
public Reference getWho()
Reference to who this agent is that was involved in the event.- Returns:
- An immutable object of type
Reference
that may be null.
-
getAltId
public String getAltId()
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.- Returns:
- An immutable object of type
String
that may be null.
-
getName
public String getName()
Human-meaningful name for the agent.- Returns:
- An immutable object of type
String
that may be null.
-
getRequestor
public Boolean getRequestor()
Indicator that the user is or is not the requestor, or initiator, for the event being audited.- Returns:
- An immutable object of type
Boolean
that is non-null.
-
getLocation
public Reference getLocation()
Where the event occurred.- Returns:
- An immutable object of type
Reference
that may be null.
-
getPolicy
public java.util.List<Uri> getPolicy()
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.- Returns:
- An unmodifiable list containing immutable objects of type
Uri
that may be empty.
-
getMedia
public Coding getMedia()
Type of media involved. Used when the event is about exporting/importing onto media.- Returns:
- An immutable object of type
Coding
that may be null.
-
getNetwork
public AuditEvent.Agent.Network getNetwork()
Logical network location for application activity, if the activity has a network location.- Returns:
- An immutable object of type
AuditEvent.Agent.Network
that may be null.
-
getPurposeOfUse
public java.util.List<CodeableConcept> getPurposeOfUse()
The reason (purpose of use), specific to this agent, that was used during the event being recorded.- Returns:
- An unmodifiable list containing immutable objects of type
CodeableConcept
that may be empty.
-
hasChildren
public boolean hasChildren()
- Overrides:
hasChildren
in classBackboneElement
-
accept
public void accept(java.lang.String elementName, int elementIndex, Visitor visitor)
Description copied from interface:Visitable
Accept a Visitor and invoke the appropriate visit methods. A typical implementation would look like this:if (visitor.preVisit(this)) { visitor.visitStart(elementName, elementIndex, this); if (visitor.visit(elementName, elementIndex, this)) { // visit children } visitor.visitEnd(elementName, elementIndex, this); visitor.postVisit(this); }
- Specified by:
accept
in interfaceVisitable
- Specified by:
accept
in classAbstractVisitable
- Parameters:
elementName
- the name of the element in the context of this visitelementIndex
- the index of the element in a list or -1 if it is not contained within a Listvisitor
- the visitor to use
-
equals
public boolean equals(java.lang.Object obj)
- Overrides:
equals
in classjava.lang.Object
-
hashCode
public int hashCode()
- Overrides:
hashCode
in classjava.lang.Object
-
toBuilder
public AuditEvent.Agent.Builder toBuilder()
Description copied from class:Element
Create a new Builder from the contents of this Element- Specified by:
toBuilder
in classBackboneElement
-
builder
public static AuditEvent.Agent.Builder builder()
-
-