Package org.hl7.fhir.r4.model

Class AuditEvent.AuditEventAgentComponent

java.lang.Object

org.hl7.fhir.r4.model.Base

org.hl7.fhir.r4.model.Element

org.hl7.fhir.r4.model.BackboneElement

org.hl7.fhir.r4.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<CodeableConcept>	purposeOfUse	The reason (purpose of use), specific to this agent, that was used during the event being recorded.
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 security role that the user was acting under, that come from local codes defined by the access control security system (e.g.
protected CodeableConcept	type	Specification of the participation type the user plays when performing the event.
protected Reference	who	Reference to who this agent is that was involved in the event.
protected Resource	whoTarget	The actual object that is the target of the reference (Reference to who this agent is that was involved in the event.)

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

modifierExtension

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

extension, id

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
Base	addChild(String name)
AuditEvent.AuditEventAgentComponent	addPolicy(String value)
UriType	addPolicyElement()
CodeableConcept	addPurposeOfUse()
AuditEvent.AuditEventAgentComponent	addPurposeOfUse(CodeableConcept t)
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()
String	getAltId()
StringType	getAltIdElement()
Reference	getLocation()
Location	getLocationTarget()
Coding	getMedia()
String	getName()
Property	getNamedProperty(int _hash, String _name, boolean _checkValid)
StringType	getNameElement()
AuditEvent.AuditEventAgentNetworkComponent	getNetwork()
List<UriType>	getPolicy()
Base[]	getProperty(int hash, String name, boolean checkValid)
List<CodeableConcept>	getPurposeOfUse()
CodeableConcept	getPurposeOfUseFirstRep()
boolean	getRequestor()
BooleanType	getRequestorElement()
List<CodeableConcept>	getRole()
CodeableConcept	getRoleFirstRep()
CodeableConcept	getType()
String[]	getTypesForProperty(int hash, String name)
Reference	getWho()
Resource	getWhoTarget()
boolean	hasAltId()
boolean	hasAltIdElement()
boolean	hasLocation()
boolean	hasMedia()
boolean	hasName()
boolean	hasNameElement()
boolean	hasNetwork()
boolean	hasPolicy()
boolean	hasPolicy(String value)
boolean	hasPurposeOfUse()
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	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)
AuditEvent.AuditEventAgentComponent	setPolicy(List<UriType> thePolicy)
Base	setProperty(int hash, String name, Base value)
Base	setProperty(String name, Base value)
AuditEvent.AuditEventAgentComponent	setPurposeOfUse(List<CodeableConcept> thePurposeOfUse)
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)
AuditEvent.AuditEventAgentComponent	setWhoTarget(Resource value)

Methods inherited from class org.hl7.fhir.r4.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.r4.model.Element

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

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

castToAddress, castToAnnotation, castToAttachment, castToBase64Binary, castToBoolean, castToCanonical, castToCode, castToCodeableConcept, castToCoding, castToContactDetail, castToContactPoint, castToContributor, castToDataRequirement, castToDate, castToDateTime, castToDecimal, castToDosage, castToDuration, castToElementDefinition, castToExpression, castToExtension, castToHumanName, castToId, castToIdentifier, castToInstant, castToInteger, castToMarkdown, castToMarketingStatus, castToMeta, castToMoney, castToNarrative, castToOid, castToParameterDefinition, castToPeriod, castToPopulation, castToPositiveInt, castToProdCharacteristic, castToProductShelfLife, castToQuantity, castToRange, castToRatio, castToReference, castToRelatedArtifact, castToResource, castToSampledData, castToSignature, castToSimpleQuantity, castToString, castToSubstanceAmount, castToTime, castToTiming, castToTriggerDefinition, castToType, castToUnsignedInt, castToUri, castToUrl, castToUsageContext, castToXhtml, castToXhtmlString, children, clearUserData, compareDeep, compareDeep, compareDeep, compareDeep, compareValues, compareValues, copyValues, dateTimeValue, equals, getChildByName, getFormatCommentsPost, getFormatCommentsPre, getNamedProperty, getUserData, getUserInt, getUserString, getXhtml, hasFormatComment, hasPrimitiveValue, hasType, hasUserData, isBooleanPrimitive, isDateTime, isMetadataBased, isPrimitive, isResource, 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 Details

type

protected CodeableConcept type

Specification of the participation type the user plays when performing the event.

role

protected List<CodeableConcept> role

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.

who

protected Reference who

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

whoTarget

protected Resource whoTarget

The actual object that is the target of the reference (Reference to who this agent is that was involved 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<CodeableConcept> purposeOfUse

The reason (purpose of use), specific to this agent, that was used during the event being recorded.

Constructor Details

AuditEventAgentComponent

public AuditEventAgentComponent()

Constructor

AuditEventAgentComponent

public AuditEventAgentComponent(BooleanType requestor)

Constructor

Method Details

getType

public CodeableConcept getType()

Returns:

type (Specification of the participation type the user plays when performing the event.)

hasType

public boolean hasType()

setType

public AuditEvent.AuditEventAgentComponent setType(CodeableConcept value)

Parameters:

value - type (Specification of the participation type the user plays when performing the event.)

getRole

public List<CodeableConcept> getRole()

Returns:

role (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.)

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

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.)

getWhoTarget

public Resource getWhoTarget()

Returns:

who 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. (Reference to who this agent is that was involved in the event.)

setWhoTarget

public AuditEvent.AuditEventAgentComponent setWhoTarget(Resource value)

Parameters:

value - who 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. (Reference to who this agent is that was involved 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.)

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 (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<CodeableConcept> getPurposeOfUse()

Returns:

purposeOfUse (The reason (purpose of use), specific to this agent, that was used during the event being recorded.)

setPurposeOfUse

public AuditEvent.AuditEventAgentComponent setPurposeOfUse(List<CodeableConcept> thePurposeOfUse)

Returns:

Returns a reference to this for easy method chaining

hasPurposeOfUse

public boolean hasPurposeOfUse()

addPurposeOfUse

public CodeableConcept addPurposeOfUse()

addPurposeOfUse

public AuditEvent.AuditEventAgentComponent addPurposeOfUse(CodeableConcept t)

getPurposeOfUseFirstRep

public CodeableConcept getPurposeOfUseFirstRep()

Returns:

The first repetition of repeating field purposeOfUse, creating it if it does not already exist

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