ca.uhn.fhir.model.dstu.resource

Class Provenance.Agent

java.lang.Object

ca.uhn.fhir.model.api.BaseElement

ca.uhn.fhir.model.api.BaseIdentifiableElement

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

All Implemented Interfaces:

ICompositeElement, IElement, IIdentifiableElement, IResourceBlock, ISupportsUndeclaredExtensions

Enclosing class:

Provenance

public static class Provenance.Agent
extends BaseIdentifiableElement
implements IResourceBlock

Block class for child element: Provenance.agent (Person, organization, records, etc. involved in creating resource)

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, a piece of software, an inanimate object, an organization, or other entities that may be ascribed responsibility

Constructor Summary

Constructors

Constructor and Description
Provenance.Agent()

Method Summary

Methods

Modifier and Type	Method and Description
<T extends IElement> List<T>	getAllPopulatedChildElementsOfType(Class<T> theType) Returns a list containing all child elements matching a given type
StringDt	getDisplay() Gets the value(s) for display (Human description of participant).
UriDt	getReference() Gets the value(s) for reference (Identity of agent (urn or url)).
CodingDt	getRole() Gets the value(s) for role (e.g.
CodingDt	getType() Gets the value(s) for type (e.g.
boolean	isEmpty()
Provenance.Agent	setDisplay(String theString) Sets the value for display (Human description of participant)
Provenance.Agent	setDisplay(StringDt theValue) Sets the value(s) for display (Human description of participant)
Provenance.Agent	setReference(String theUri) Sets the value for reference (Identity of agent (urn or url))
Provenance.Agent	setReference(UriDt theValue) Sets the value(s) for reference (Identity of agent (urn or url))
Provenance.Agent	setRole(CodingDt theValue) Sets the value(s) for role (e.g.
Provenance.Agent	setType(CodingDt theValue) Sets the value(s) for type (e.g.

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

Provenance.Agent

public Provenance.Agent()

Method Detail

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface IElement

getAllPopulatedChildElementsOfType

public <T extends IElement> List<T> getAllPopulatedChildElementsOfType(Class<T> theType)

Description copied from interface: ICompositeElement

Returns a list containing all child elements matching a given type

Specified by:

getAllPopulatedChildElementsOfType in interface ICompositeElement

Parameters:

theType - The type to match. If set to null, all child elements will be returned

getRole

public CodingDt getRole()

Gets the value(s) for role (e.g. author | overseer | enterer | attester | source | cc: +). creating it if it does not exist. Will not return null.

Definition: The role that the participant played

setRole

public Provenance.Agent setRole(CodingDt theValue)

Sets the value(s) for role (e.g. author | overseer | enterer | attester | source | cc: +)

Definition: The role that the participant played

getType

public CodingDt getType()

Gets the value(s) for type (e.g. Resource | Person | Application | Record | Document +). creating it if it does not exist. Will not return null.

Definition: The type of the participant

setType

public Provenance.Agent setType(CodingDt theValue)

Sets the value(s) for type (e.g. Resource | Person | Application | Record | Document +)

Definition: The type of the participant

getReference

public UriDt getReference()

Gets the value(s) for reference (Identity of agent (urn or url)). creating it if it does not exist. Will not return null.

Definition: Identity of participant. May be a logical or physical uri and maybe absolute or relative

setReference

public Provenance.Agent setReference(UriDt theValue)

Sets the value(s) for reference (Identity of agent (urn or url))

Definition: Identity of participant. May be a logical or physical uri and maybe absolute or relative

setReference

public Provenance.Agent setReference(String theUri)

Sets the value for reference (Identity of agent (urn or url))

Definition: Identity of participant. May be a logical or physical uri and maybe absolute or relative

getDisplay

public StringDt getDisplay()

Gets the value(s) for display (Human description of participant). creating it if it does not exist. Will not return null.

Definition: Human-readable description of the participant

setDisplay

public Provenance.Agent setDisplay(StringDt theValue)

Sets the value(s) for display (Human description of participant)

Definition: Human-readable description of the participant

setDisplay

public Provenance.Agent setDisplay(String theString)

Sets the value for display (Human description of participant)

Definition: Human-readable description of the participant