Package org.hl7.fhir.r5.model

Class AuditEvent.AuditEventAgentComponent

java.lang.Object

org.hl7.fhir.r5.model.Base

org.hl7.fhir.r5.model.Element

org.hl7.fhir.r5.model.BackboneElement

org.hl7.fhir.r5.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

Nested Class Summary

Nested classes/interfaces inherited from class org.hl7.fhir.r5.model.Base

Base.ProfileSource, Base.ValidationInfo, Base.ValidationMode, Base.ValidationReason

Field Summary

Fields

Modifier and Type	Field	Description
protected List<CodeableConcept>	authorization	The authorization (e.g., PurposeOfUse) that was used during the event being recorded.
protected Reference	location	Where the agent location is known, the agent location when the event occurred.
protected DataType	network	When the event utilizes a network there should be an agent describing the local system, and an agent describing remote system, with the network interface details.
protected List<UriType>	policy	Where the policy(ies) are known that authorized the agent participation in the event.
protected BooleanType	requestor	Indicator that the user is or is not the requestor, or initiator, for the event being audited.
protected List<CodeableConcept>	role	The structural roles of the agent indicating the agent's competency.
protected CodeableConcept	type	The Functional Role of the user when performing the event.
protected Reference	who	Reference to who this agent is that was involved in the event.

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

modifierExtension

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

extension, id

Constructor Summary

Constructors

Constructor	Description
AuditEventAgentComponent()	Constructor
AuditEventAgentComponent(Reference who)	Constructor

Method Summary

Modifier and Type	Method	Description
CodeableConcept	addAuthorization()
AuditEvent.AuditEventAgentComponent	addAuthorization(CodeableConcept t)
Base	addChild(String name)
AuditEvent.AuditEventAgentComponent	addPolicy(String value)
UriType	addPolicyElement()
CodeableConcept	addRole()
AuditEvent.AuditEventAgentComponent	addRole(CodeableConcept t)
AuditEvent.AuditEventAgentComponent	copy()
void	copyValues(AuditEvent.AuditEventAgentComponent dst)
boolean	equalsDeep(Base other_)
boolean	equalsShallow(Base other_)
String	fhirType()
List<CodeableConcept>	getAuthorization()
CodeableConcept	getAuthorizationFirstRep()
Reference	getLocation()
Property	getNamedProperty(int _hash, String _name, boolean _checkValid)
DataType	getNetwork()
Reference	getNetworkReference()
StringType	getNetworkStringType()
UriType	getNetworkUriType()
List<UriType>	getPolicy()
Base[]	getProperty(int hash, String name, boolean checkValid)
boolean	getRequestor()
BooleanType	getRequestorElement()
List<CodeableConcept>	getRole()
CodeableConcept	getRoleFirstRep()
CodeableConcept	getType()
String[]	getTypesForProperty(int hash, String name)
Reference	getWho()
boolean	hasAuthorization()
boolean	hasLocation()
boolean	hasNetwork()
boolean	hasNetworkReference()
boolean	hasNetworkStringType()
boolean	hasNetworkUriType()
boolean	hasPolicy()
boolean	hasPolicy(String value)
boolean	hasRequestor()
boolean	hasRequestorElement()
boolean	hasRole()
boolean	hasType()
boolean	hasWho()
boolean	isEmpty()
protected void	listChildren(List<Property> children)
Base	makeProperty(int hash, String name)
void	removeChild(String name, Base value)
AuditEvent.AuditEventAgentComponent	setAuthorization(List<CodeableConcept> theAuthorization)
AuditEvent.AuditEventAgentComponent	setLocation(Reference value)
AuditEvent.AuditEventAgentComponent	setNetwork(DataType value)
AuditEvent.AuditEventAgentComponent	setPolicy(List<UriType> thePolicy)
Base	setProperty(int hash, String name, Base value)
Base	setProperty(String name, Base value)
AuditEvent.AuditEventAgentComponent	setRequestor(boolean value)
AuditEvent.AuditEventAgentComponent	setRequestorElement(BooleanType value)
AuditEvent.AuditEventAgentComponent	setRole(List<CodeableConcept> theRole)
AuditEvent.AuditEventAgentComponent	setType(CodeableConcept value)
AuditEvent.AuditEventAgentComponent	setWho(Reference value)

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

addModifierExtension, addModifierExtension, addModifierExtension, checkNoModifiers, copyExtensions, copyNewExtensions, copyValues, getExtensionByUrl, getExtensionsByUrl, getExtensionsByUrl, getModifierExtension, getModifierExtensionFirstRep, hasExtension, hasExtension, hasModifierExtension, removeExtension, setModifierExtension

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

addExtension, addExtension, addExtension, copyExtensions, copyNewExtensions, copyValues, getExtension, getExtensionFirstRep, getExtensionString, getExtensionString, getFHIRPublicationVersion, getId, getIdBase, getIdElement, getStandardsStatus, hasExtension, hasExtension, hasId, hasIdElement, isDisallowExtensions, noExtensions, setDisallowExtensions, setExtension, setId, setIdBase, setIdElement, setStandardsStatus

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

addDefinition, addFormatCommentsPost, addFormatCommentsPre, addValidationMessage, canHavePrimitiveValue, children, clearUserData, compareDeep, compareDeep, compareDeep, compareDeep, compareValues, compareValues, copyFormatComments, copyUserData, copyValues, dateTimeValue, equals, getChildByName, getChildValueByName, getFormatCommentsPost, getFormatCommentsPre, getNamedProperty, getUserData, getUserInt, getUserString, getValidationInfo, getValidationMessages, getXhtml, hasFormatComment, hasFormatCommentPost, hasFormatCommentPre, hasPrimitiveValue, hasType, hasUserData, hasValidated, hasValidationInfo, hasValidationMessages, isBooleanPrimitive, isCopyUserData, isDateTime, isMetadataBased, isPrimitive, isResource, listChildrenByName, listChildrenByName, primitiveValue, setCopyUserData, 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 Details

type

protected CodeableConcept type

The Functional Role of the user when performing the event.

role

protected List<CodeableConcept> role

The structural roles of the agent indicating the agent's competency. The security role enabling the agent with respect to the activity.

who

protected Reference who

Reference to who this agent is that was involved in the event.

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 agent location is known, the agent location when the event occurred.

policy

protected List<UriType> policy

Where the policy(ies) are known that authorized the agent participation in the event. 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.

network

protected DataType network

When the event utilizes a network there should be an agent describing the local system, and an agent describing remote system, with the network interface details.

authorization

protected List<CodeableConcept> authorization

The authorization (e.g., PurposeOfUse) that was used during the event being recorded.

Constructor Details

AuditEventAgentComponent

public AuditEventAgentComponent()

Constructor

AuditEventAgentComponent

public AuditEventAgentComponent(Reference who)

Constructor

Method Details

getType

public CodeableConcept getType()

Returns:

type (The Functional Role of the user when performing the event.)

hasType

public boolean hasType()

setType

public AuditEvent.AuditEventAgentComponent setType(CodeableConcept value)

Parameters:

value - type (The Functional Role of the user when performing the event.)

getRole

public List<CodeableConcept> getRole()

Returns:

role (The structural roles of the agent indicating the agent's competency. The security role enabling the agent with respect to the activity.)

setRole

public AuditEvent.AuditEventAgentComponent setRole(List<CodeableConcept> theRole)

Returns:

Returns a reference to this for easy method chaining

hasRole

public boolean hasRole()

addRole

public CodeableConcept addRole()

addRole

public AuditEvent.AuditEventAgentComponent addRole(CodeableConcept t)

getRoleFirstRep

public CodeableConcept getRoleFirstRep()

Returns:

The first repetition of repeating field role, creating it if it does not already exist {3}

getWho

public Reference getWho()

Returns:

who (Reference to who this agent is that was involved in the event.)

hasWho

public boolean hasWho()

setWho

public AuditEvent.AuditEventAgentComponent setWho(Reference value)

Parameters:

value - who (Reference to who this agent is that was involved in the event.)

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 agent location is known, the agent location when the event occurred.)

hasLocation

public boolean hasLocation()

setLocation

public AuditEvent.AuditEventAgentComponent setLocation(Reference value)

Parameters:

value - location (Where the agent location is known, the agent location when the event occurred.)

getPolicy

public List<UriType> getPolicy()

Returns:

policy (Where the policy(ies) are known that authorized the agent participation in the event. 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.)

setPolicy

public AuditEvent.AuditEventAgentComponent setPolicy(List<UriType> thePolicy)

Returns:

Returns a reference to this for easy method chaining

hasPolicy

public boolean hasPolicy()

addPolicyElement

public UriType addPolicyElement()

Returns:

policy (Where the policy(ies) are known that authorized the agent participation in the event. 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 (Where the policy(ies) are known that authorized the agent participation in the event. 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 (Where the policy(ies) are known that authorized the agent participation in the event. 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.)

getNetwork

public DataType getNetwork()

Returns:

network (When the event utilizes a network there should be an agent describing the local system, and an agent describing remote system, with the network interface details.)

getNetworkReference

public Reference getNetworkReference()
                              throws org.hl7.fhir.exceptions.FHIRException

Returns:

network (When the event utilizes a network there should be an agent describing the local system, and an agent describing remote system, with the network interface details.)

Throws:

org.hl7.fhir.exceptions.FHIRException

hasNetworkReference

public boolean hasNetworkReference()

getNetworkUriType

public UriType getNetworkUriType()
                          throws org.hl7.fhir.exceptions.FHIRException

Returns:

network (When the event utilizes a network there should be an agent describing the local system, and an agent describing remote system, with the network interface details.)

Throws:

org.hl7.fhir.exceptions.FHIRException

hasNetworkUriType

public boolean hasNetworkUriType()

getNetworkStringType

public StringType getNetworkStringType()
                                throws org.hl7.fhir.exceptions.FHIRException

Returns:

network (When the event utilizes a network there should be an agent describing the local system, and an agent describing remote system, with the network interface details.)

Throws:

org.hl7.fhir.exceptions.FHIRException

hasNetworkStringType

public boolean hasNetworkStringType()

hasNetwork

public boolean hasNetwork()

setNetwork

public AuditEvent.AuditEventAgentComponent setNetwork(DataType value)

Parameters:

value - network (When the event utilizes a network there should be an agent describing the local system, and an agent describing remote system, with the network interface details.)

getAuthorization

public List<CodeableConcept> getAuthorization()

Returns:

authorization (The authorization (e.g., PurposeOfUse) that was used during the event being recorded.)

setAuthorization

public AuditEvent.AuditEventAgentComponent setAuthorization(List<CodeableConcept> theAuthorization)

Returns:

Returns a reference to this for easy method chaining

hasAuthorization

public boolean hasAuthorization()

addAuthorization

public CodeableConcept addAuthorization()

addAuthorization

public AuditEvent.AuditEventAgentComponent addAuthorization(CodeableConcept t)

getAuthorizationFirstRep

public CodeableConcept getAuthorizationFirstRep()

Returns:

The first repetition of repeating field authorization, creating it if it does not already exist {3}

listChildren

protected void listChildren(List<Property> children)

Overrides:

listChildren in class BackboneElement

getNamedProperty

public Property getNamedProperty(int _hash,
 String _name,
 boolean _checkValid)
                          throws org.hl7.fhir.exceptions.FHIRException

Overrides:

getNamedProperty in class BackboneElement

Throws:

org.hl7.fhir.exceptions.FHIRException

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 Base 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 Base setProperty(String name,
 Base value)
                 throws org.hl7.fhir.exceptions.FHIRException

Overrides:

setProperty in class BackboneElement

Throws:

org.hl7.fhir.exceptions.FHIRException

removeChild

public void removeChild(String name,
 Base value)
                 throws org.hl7.fhir.exceptions.FHIRException

Overrides:

removeChild in class BackboneElement

Throws:

org.hl7.fhir.exceptions.FHIRException

makeProperty

public Base makeProperty(int hash,
 String name)
                  throws org.hl7.fhir.exceptions.FHIRException

Overrides:

makeProperty in class BackboneElement

Throws:

org.hl7.fhir.exceptions.FHIRException

getTypesForProperty

public String[] getTypesForProperty(int hash,
 String name)
                             throws org.hl7.fhir.exceptions.FHIRException

Overrides:

getTypesForProperty in class BackboneElement

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

copyValues

public void copyValues(AuditEvent.AuditEventAgentComponent dst)

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

Returns:

the FHIR type name of the instance (not the java class name)