ca.uhn.fhir.model.dstu.resource

Class Provenance.Entity

java.lang.Object

ca.uhn.fhir.model.api.BaseElement

ca.uhn.fhir.model.api.BaseIdentifiableElement

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

All Implemented Interfaces:

ICompositeElement, IElement, IIdentifiableElement, IResourceBlock, ISupportsUndeclaredExtensions

Enclosing class:

Provenance

public static class Provenance.Entity
extends BaseIdentifiableElement
implements IResourceBlock

Block class for child element: Provenance.entity (An entity used in this activity)

Definition: An entity used in this activity

Constructor Summary

Constructors

Constructor and Description
Provenance.Entity()

Method Summary

Methods

Modifier and Type	Method and Description
Provenance.Agent	getAgent() Gets the value(s) for agent (Entity is attributed to this agent).
<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 participant (urn or url)).
BoundCodeDt<ProvenanceEntityRoleEnum>	getRole() Gets the value(s) for role (derivation | revision | quotation | source).
CodingDt	getType() Gets the value(s) for type (Resource Type, or something else).
boolean	isEmpty()
Provenance.Entity	setAgent(Provenance.Agent theValue) Sets the value(s) for agent (Entity is attributed to this agent)
Provenance.Entity	setDisplay(String theString) Sets the value for display (Human description of participant)
Provenance.Entity	setDisplay(StringDt theValue) Sets the value(s) for display (Human description of participant)
Provenance.Entity	setReference(String theUri) Sets the value for reference (Identity of participant (urn or url))
Provenance.Entity	setReference(UriDt theValue) Sets the value(s) for reference (Identity of participant (urn or url))
Provenance.Entity	setRole(BoundCodeDt<ProvenanceEntityRoleEnum> theValue) Sets the value(s) for role (derivation | revision | quotation | source)
Provenance.Entity	setRole(ProvenanceEntityRoleEnum theValue) Sets the value(s) for role (derivation | revision | quotation | source)
Provenance.Entity	setType(CodingDt theValue) Sets the value(s) for type (Resource Type, or something else)

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

public Provenance.Entity()

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 BoundCodeDt<ProvenanceEntityRoleEnum> getRole()

Gets the value(s) for role (derivation | revision | quotation | source). creating it if it does not exist. Will not return null.

Definition: How the entity was used during the activity

setRole

public Provenance.Entity setRole(BoundCodeDt<ProvenanceEntityRoleEnum> theValue)

Sets the value(s) for role (derivation | revision | quotation | source)

Definition: How the entity was used during the activity

setRole

public Provenance.Entity setRole(ProvenanceEntityRoleEnum theValue)

Sets the value(s) for role (derivation | revision | quotation | source)

Definition: How the entity was used during the activity

getType

public CodingDt getType()

Gets the value(s) for type (Resource Type, or something else). creating it if it does not exist. Will not return null.

Definition: The type of the entity. If the entity is a resource, then this is a resource type

setType

public Provenance.Entity setType(CodingDt theValue)

Sets the value(s) for type (Resource Type, or something else)

Definition: The type of the entity. If the entity is a resource, then this is a resource type

getReference

public UriDt getReference()

Gets the value(s) for reference (Identity of participant (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.Entity setReference(UriDt theValue)

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

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

setReference

public Provenance.Entity setReference(String theUri)

Sets the value for reference (Identity of participant (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 entity

setDisplay

public Provenance.Entity setDisplay(StringDt theValue)

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

Definition: Human-readable description of the entity

setDisplay

public Provenance.Entity setDisplay(String theString)

Sets the value for display (Human description of participant)

Definition: Human-readable description of the entity

getAgent

public Provenance.Agent getAgent()

Gets the value(s) for agent (Entity is attributed to this agent). creating it if it does not exist. Will not return null.

Definition: The entity is attributed to an agent to express the agent's responsibility for that entity, possibly along with other agents. This description can be understood as shorthand for saying that the agent was responsible for the activity which generated the entity

setAgent

public Provenance.Entity setAgent(Provenance.Agent theValue)

Sets the value(s) for agent (Entity is attributed to this agent)

Definition: The entity is attributed to an agent to express the agent's responsibility for that entity, possibly along with other agents. This description can be understood as shorthand for saying that the agent was responsible for the activity which generated the entity