ca.uhn.fhir.model.dstu2.resource

Class Provenance.Agent

java.lang.Object

ca.uhn.fhir.model.api.BaseElement

ca.uhn.fhir.model.api.BaseIdentifiableElement

ca.uhn.fhir.model.dstu2.resource.Provenance.Agent

All Implemented Interfaces:

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

Enclosing class:

Provenance

public static class Provenance.Agent
extends BaseIdentifiableElement
implements IResourceBlock

Block class for child element: Provenance.agent (who)

Definition: An agent takes a role in an activity such that the agent can be assigned some degree of responsibility for the activity taking place. An agent can be a person, an organization, software, or other entities that may be ascribed responsibility

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
Agent()

Method Summary

Modifier and Type	Method and Description
Provenance.AgentRelatedAgent	addRelatedAgent() Adds and returns a new value for relatedAgent ()
Provenance.Agent	addRelatedAgent(Provenance.AgentRelatedAgent theValue) Adds a given new value for relatedAgent ()
ResourceReferenceDt	getActor() Gets the value(s) for actor (who.actor).
<T extends IElement> List<T>	getAllPopulatedChildElementsOfType(Class<T> theType)
List<Provenance.AgentRelatedAgent>	getRelatedAgent() Gets the value(s) for relatedAgent ().
Provenance.AgentRelatedAgent	getRelatedAgentFirstRep() Gets the first repetition for relatedAgent (), creating it if it does not already exist.
CodingDt	getRole() Gets the value(s) for role ().
IdentifierDt	getUserId() Gets the value(s) for userId (who.actor).
boolean	isEmpty()
Provenance.Agent	setActor(ResourceReferenceDt theValue) Sets the value(s) for actor (who.actor)
Provenance.Agent	setRelatedAgent(List<Provenance.AgentRelatedAgent> theValue) Sets the value(s) for relatedAgent ()
Provenance.Agent	setRole(CodingDt theValue) Sets the value(s) for role ()
Provenance.Agent	setUserId(IdentifierDt theValue) Sets the value(s) for userId (who.actor)

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

Agent

public Agent()

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 CodingDt getRole()

Gets the value(s) for role (). creating it if it does not exist. Will not return null.

Definition: The function of the agent with respect to the activity.

setRole

public Provenance.Agent setRole(CodingDt theValue)

Sets the value(s) for role ()

Definition: The function of the agent with respect to the activity.

getActor

public ResourceReferenceDt getActor()

Gets the value(s) for actor (who.actor). creating it if it does not exist. Will not return null.

Definition: The individual, device or organization that participated in the event

setActor

public Provenance.Agent setActor(ResourceReferenceDt theValue)

Sets the value(s) for actor (who.actor)

Definition: The individual, device or organization that participated in the event

getUserId

public IdentifierDt getUserId()

Gets the value(s) for userId (who.actor). creating it if it does not exist. Will not return null.

Definition: The identity of the agent as known by the authorization system

setUserId

public Provenance.Agent setUserId(IdentifierDt theValue)

Sets the value(s) for userId (who.actor)

Definition: The identity of the agent as known by the authorization system

getRelatedAgent

public List<Provenance.AgentRelatedAgent> getRelatedAgent()

Gets the value(s) for relatedAgent (). creating it if it does not exist. Will not return null.

Definition: A relationship between two the agents referenced in this resource. This is defined to allow for explicit description of the delegation between agents. For example, this human author used this device, or one person acted on another's behest

setRelatedAgent

public Provenance.Agent setRelatedAgent(List<Provenance.AgentRelatedAgent> theValue)

Sets the value(s) for relatedAgent ()

Definition: A relationship between two the agents referenced in this resource. This is defined to allow for explicit description of the delegation between agents. For example, this human author used this device, or one person acted on another's behest

addRelatedAgent

public Provenance.AgentRelatedAgent addRelatedAgent()

Adds and returns a new value for relatedAgent ()

Definition: A relationship between two the agents referenced in this resource. This is defined to allow for explicit description of the delegation between agents. For example, this human author used this device, or one person acted on another's behest

addRelatedAgent

public Provenance.Agent addRelatedAgent(Provenance.AgentRelatedAgent theValue)

Adds a given new value for relatedAgent ()

Definition: A relationship between two the agents referenced in this resource. This is defined to allow for explicit description of the delegation between agents. For example, this human author used this device, or one person acted on another's behest

Parameters:

theValue - The relatedAgent to add (must not be null)

getRelatedAgentFirstRep

public Provenance.AgentRelatedAgent getRelatedAgentFirstRep()

Gets the first repetition for relatedAgent (), creating it if it does not already exist.

Definition: A relationship between two the agents referenced in this resource. This is defined to allow for explicit description of the delegation between agents. For example, this human author used this device, or one person acted on another's behest