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

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

All Implemented Interfaces:

ICompositeElement, IElement, IIdentifiableElement, IResourceBlock, ISupportsUndeclaredExtensions, Serializable, IBase

Enclosing class:

AuditEvent
```
public static class AuditEvent.Participant
extends BaseIdentifiableElement
implements IResourceBlock
```
Block class for child element: AuditEvent.participant ()
Definition:

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description

Participant()

Constructors
Constructor and Description
`Participant()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`UriDt`	`addPolicy()` Adds and returns a new value for policy ()
`AuditEvent.Participant`	`addPolicy(String theUri)` Adds a new value for policy ()
`AuditEvent.Participant`	`addPolicy(UriDt theValue)` Adds a given new value for policy ()
`CodingDt`	`addPurposeOfUse()` Adds and returns a new value for purposeOfUse ()
`AuditEvent.Participant`	`addPurposeOfUse(CodingDt theValue)` Adds a given new value for purposeOfUse ()
`CodeableConceptDt`	`addRole()` Adds and returns a new value for role ()
`AuditEvent.Participant`	`addRole(CodeableConceptDt theValue)` Adds a given new value for role ()
`<T extends IElement> List<T>`	`getAllPopulatedChildElementsOfType(Class<T> theType)`
`String`	`getAltId()` Gets the value(s) for altId ().
`StringDt`	`getAltIdElement()` Gets the value(s) for altId ().
`ResourceReferenceDt`	`getLocation()` Gets the value(s) for location ().
`CodingDt`	`getMedia()` Gets the value(s) for media ().
`String`	`getName()` Gets the value(s) for name ().
`StringDt`	`getNameElement()` Gets the value(s) for name ().
`AuditEvent.ParticipantNetwork`	`getNetwork()` Gets the value(s) for network ().
`List<UriDt>`	`getPolicy()` Gets the value(s) for policy ().
`UriDt`	`getPolicyFirstRep()` Gets the first repetition for policy (), creating it if it does not already exist.
`List<CodingDt>`	`getPurposeOfUse()` Gets the value(s) for purposeOfUse ().
`CodingDt`	`getPurposeOfUseFirstRep()` Gets the first repetition for purposeOfUse (), creating it if it does not already exist.
`ResourceReferenceDt`	`getReference()` Gets the value(s) for reference ().
`Boolean`	`getRequestor()` Gets the value(s) for requestor ().
`BooleanDt`	`getRequestorElement()` Gets the value(s) for requestor ().
`List<CodeableConceptDt>`	`getRole()` Gets the value(s) for role ().
`CodeableConceptDt`	`getRoleFirstRep()` Gets the first repetition for role (), creating it if it does not already exist.
`IdentifierDt`	`getUserId()` Gets the value(s) for userId ().
`boolean`	`isEmpty()`
`AuditEvent.Participant`	`setAltId(String theString)` Sets the value for altId ()
`AuditEvent.Participant`	`setAltId(StringDt theValue)` Sets the value(s) for altId ()
`AuditEvent.Participant`	`setLocation(ResourceReferenceDt theValue)` Sets the value(s) for location ()
`AuditEvent.Participant`	`setMedia(CodingDt theValue)` Sets the value(s) for media ()
`AuditEvent.Participant`	`setName(String theString)` Sets the value for name ()
`AuditEvent.Participant`	`setName(StringDt theValue)` Sets the value(s) for name ()
`AuditEvent.Participant`	`setNetwork(AuditEvent.ParticipantNetwork theValue)` Sets the value(s) for network ()
`AuditEvent.Participant`	`setPolicy(List<UriDt> theValue)` Sets the value(s) for policy ()
`AuditEvent.Participant`	`setPurposeOfUse(List<CodingDt> theValue)` Sets the value(s) for purposeOfUse ()
`AuditEvent.Participant`	`setReference(ResourceReferenceDt theValue)` Sets the value(s) for reference ()
`AuditEvent.Participant`	`setRequestor(boolean theBoolean)` Sets the value for requestor ()
`AuditEvent.Participant`	`setRequestor(BooleanDt theValue)` Sets the value(s) for requestor ()
`AuditEvent.Participant`	`setRole(List<CodeableConceptDt> theValue)` Sets the value(s) for role ()
`AuditEvent.Participant`	`setUserId(IdentifierDt theValue)` Sets the value(s) for userId ()

Methods inherited from class ca.uhn.fhir.model.api.BaseIdentifiableElement
getElementSpecificId, getId, setElementSpecificId, setId, setId

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

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

Methods inherited from interface ca.uhn.fhir.model.api.IIdentifiableElement
getElementSpecificId, getId, setElementSpecificId, setId, setId

- Constructor Detail
  - Participant
```
public Participant()
```
- 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
  - getRole
```
public List<CodeableConceptDt> getRole()
```
    Gets the value(s) for role (). creating it if it does not exist. Will not return null.
    Definition: 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 role-based access control security system used in the local context
  - setRole
```
public AuditEvent.Participant setRole(List<CodeableConceptDt> theValue)
```
    Sets the value(s) for role ()
    Definition: 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 role-based access control security system used in the local context
  - addRole
```
public CodeableConceptDt addRole()
```
    Adds and returns a new value for role ()
    Definition: 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 role-based access control security system used in the local context
  - addRole
```
public AuditEvent.Participant addRole(CodeableConceptDt theValue)
```
    Adds a given new value for role ()
    Definition: 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 role-based access control security system used in the local context
    
    Parameters:
    
    theValue - The role to add (must not be null)
  - getRoleFirstRep
```
public CodeableConceptDt getRoleFirstRep()
```
    Gets the first repetition for role (), creating it if it does not already exist.
    Definition: 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 role-based access control security system used in the local context
  - getReference
```
public ResourceReferenceDt getReference()
```
    Gets the value(s) for reference (). creating it if it does not exist. Will not return null.
    Definition: Direct reference to a resource that identifies the participant
  - setReference
```
public AuditEvent.Participant setReference(ResourceReferenceDt theValue)
```
    Sets the value(s) for reference ()
    Definition: Direct reference to a resource that identifies the participant
  - getUserId
```
public IdentifierDt getUserId()
```
    Gets the value(s) for userId (). creating it if it does not exist. Will not return null.
    Definition: Unique identifier for the user actively participating in the event
  - setUserId
```
public AuditEvent.Participant setUserId(IdentifierDt theValue)
```
    Sets the value(s) for userId ()
    Definition: Unique identifier for the user actively participating in the event
  - getAltIdElement
```
public StringDt getAltIdElement()
```
    Gets the value(s) for altId (). creating it if it does not exist. Will not return null.
    Definition: Alternative Participant 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
  - getAltId
```
public String getAltId()
```
    Gets the value(s) for altId (). creating it if it does not exist. Will not return null.
    Definition: Alternative Participant 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.Participant setAltId(StringDt theValue)
```
    Sets the value(s) for altId ()
    Definition: Alternative Participant 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.Participant setAltId(String theString)
```
    Sets the value for altId ()
    Definition: Alternative Participant 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 StringDt getNameElement()
```
    Gets the value(s) for name (). creating it if it does not exist. Will not return null.
    Definition: Human-meaningful name for the user
  - getName
```
public String getName()
```
    Gets the value(s) for name (). creating it if it does not exist. Will not return null.
    Definition: Human-meaningful name for the user
  - setName
```
public AuditEvent.Participant setName(StringDt theValue)
```
    Sets the value(s) for name ()
    Definition: Human-meaningful name for the user
  - setName
```
public AuditEvent.Participant setName(String theString)
```
    Sets the value for name ()
    Definition: Human-meaningful name for the user
  - getRequestorElement
```
public BooleanDt getRequestorElement()
```
    Gets the value(s) for requestor (). creating it if it does not exist. Will not return null.
    Definition: Indicator that the user is or is not the requestor, or initiator, for the event being audited.
  - getRequestor
```
public Boolean getRequestor()
```
    Gets the value(s) for requestor (). creating it if it does not exist. Will not return null.
    Definition: Indicator that the user is or is not the requestor, or initiator, for the event being audited.
  - setRequestor
```
public AuditEvent.Participant setRequestor(BooleanDt theValue)
```
    Sets the value(s) for requestor ()
    Definition: Indicator that the user is or is not the requestor, or initiator, for the event being audited.
  - setRequestor
```
public AuditEvent.Participant setRequestor(boolean theBoolean)
```
    Sets the value for requestor ()
    Definition: Indicator that the user is or is not the requestor, or initiator, for the event being audited.
  - getLocation
```
public ResourceReferenceDt getLocation()
```
    Gets the value(s) for location (). creating it if it does not exist. Will not return null.
    Definition: Where the event occurred
  - setLocation
```
public AuditEvent.Participant setLocation(ResourceReferenceDt theValue)
```
    Sets the value(s) for location ()
    Definition: Where the event occurred
  - getPolicy
```
public List<UriDt> getPolicy()
```
    Gets the value(s) for policy (). creating it if it does not exist. Will not return null.
    Definition: 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.Participant setPolicy(List<UriDt> theValue)
```
    Sets the value(s) for policy ()
    Definition: 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 UriDt addPolicy()
```
    Adds and returns a new value for policy ()
    Definition: 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.Participant addPolicy(UriDt theValue)
```
    Adds a given new value for policy ()
    Definition: 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.
    
    Parameters:
    
    theValue - The policy to add (must not be null)
  - getPolicyFirstRep
```
public UriDt getPolicyFirstRep()
```
    Gets the first repetition for policy (), creating it if it does not already exist.
    Definition: 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.Participant addPolicy(String theUri)
```
    Adds a new value for policy ()
    Definition: 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:
    
    Returns a reference to this object, to allow for simple chaining.
  - getMedia
```
public CodingDt getMedia()
```
    Gets the value(s) for media (). creating it if it does not exist. Will not return null.
    Definition: Type of media involved. Used when the event is about exporting/importing onto media
  - setMedia
```
public AuditEvent.Participant setMedia(CodingDt theValue)
```
    Sets the value(s) for media ()
    Definition: Type of media involved. Used when the event is about exporting/importing onto media
  - getNetwork
```
public AuditEvent.ParticipantNetwork getNetwork()
```
    Gets the value(s) for network (). creating it if it does not exist. Will not return null.
    Definition: Logical network location for application activity, if the activity has a network location
  - setNetwork
```
public AuditEvent.Participant setNetwork(AuditEvent.ParticipantNetwork theValue)
```
    Sets the value(s) for network ()
    Definition: Logical network location for application activity, if the activity has a network location
  - getPurposeOfUse
```
public List<CodingDt> getPurposeOfUse()
```
    Gets the value(s) for purposeOfUse (). creating it if it does not exist. Will not return null.
    Definition: The reason (purpose of use), specific to this participant, that was used during the event being recorded.
  - setPurposeOfUse
```
public AuditEvent.Participant setPurposeOfUse(List<CodingDt> theValue)
```
    Sets the value(s) for purposeOfUse ()
    Definition: The reason (purpose of use), specific to this participant, that was used during the event being recorded.
  - addPurposeOfUse
```
public CodingDt addPurposeOfUse()
```
    Adds and returns a new value for purposeOfUse ()
    Definition: The reason (purpose of use), specific to this participant, that was used during the event being recorded.
  - addPurposeOfUse
```
public AuditEvent.Participant addPurposeOfUse(CodingDt theValue)
```
    Adds a given new value for purposeOfUse ()
    Definition: The reason (purpose of use), specific to this participant, that was used during the event being recorded.
    
    Parameters:
    
    theValue - The purposeOfUse to add (must not be null)
  - getPurposeOfUseFirstRep
```
public CodingDt getPurposeOfUseFirstRep()
```
    Gets the first repetition for purposeOfUse (), creating it if it does not already exist.
    Definition: The reason (purpose of use), specific to this participant, that was used during the event being recorded.

Class AuditEvent.Participant

Constructor Summary

Method Summary

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

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

Constructor Detail

Participant

Method Detail

isEmpty

getAllPopulatedChildElementsOfType

getRole

setRole

addRole

addRole

getRoleFirstRep

getReference

setReference

getUserId

setUserId

getAltIdElement

getAltId

setAltId

setAltId

getNameElement

getName

setName

setName

getRequestorElement

getRequestor

setRequestor

setRequestor

getLocation

setLocation

getPolicy

setPolicy

addPolicy

addPolicy

getPolicyFirstRep

addPolicy

getMedia

setMedia

getNetwork

setNetwork

getPurposeOfUse

setPurposeOfUse

addPurposeOfUse

addPurposeOfUse

getPurposeOfUseFirstRep