Package org.hl7.fhir.dstu2.model

Class Provenance.ProvenanceAgentComponent

java.lang.Object

org.hl7.fhir.dstu2.model.Base

org.hl7.fhir.dstu2.model.Element

org.hl7.fhir.dstu2.model.BackboneElement

org.hl7.fhir.dstu2.model.Provenance.ProvenanceAgentComponent

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:

Provenance

public static class Provenance.ProvenanceAgentComponent
extends BackboneElement
implements org.hl7.fhir.instance.model.api.IBaseBackboneElement

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected Reference	actor	The individual, device or organization that participated in the event.
protected Resource	actorTarget	The actual object that is the target of the reference (The individual, device or organization that participated in the event.)
protected List<Provenance.ProvenanceAgentRelatedAgentComponent>	relatedAgent	A relationship between two the agents referenced in this resource.
protected Coding	role	The function of the agent with respect to the activity.
protected Identifier	userId	The identity of the agent as known by the authorization system.

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

modifierExtension

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

extension, id

Constructor Summary

Constructors

Constructor	Description
ProvenanceAgentComponent()
ProvenanceAgentComponent(Coding role)

Method Summary

Modifier and Type	Method	Description
Base	addChild(String name)
Provenance.ProvenanceAgentRelatedAgentComponent	addRelatedAgent()
Provenance.ProvenanceAgentComponent	addRelatedAgent(Provenance.ProvenanceAgentRelatedAgentComponent t)
Provenance.ProvenanceAgentComponent	copy()
boolean	equalsDeep(Base other)
boolean	equalsShallow(Base other)
String	fhirType()
Reference	getActor()
Resource	getActorTarget()
List<Provenance.ProvenanceAgentRelatedAgentComponent>	getRelatedAgent()
Coding	getRole()
Identifier	getUserId()
boolean	hasActor()
boolean	hasRelatedAgent()
boolean	hasRole()
boolean	hasUserId()
boolean	isEmpty()
protected void	listChildren(List<Property> childrenList)
Provenance.ProvenanceAgentComponent	setActor(Reference value)
Provenance.ProvenanceAgentComponent	setActorTarget(Resource value)
void	setProperty(String name, Base value)
Provenance.ProvenanceAgentComponent	setRole(Coding value)
Provenance.ProvenanceAgentComponent	setUserId(Identifier value)

Methods inherited from class org.hl7.fhir.dstu2.model.BackboneElement

addModifierExtension, addModifierExtension, copyValues, getModifierExtension, hasModifierExtension

Methods inherited from class org.hl7.fhir.dstu2.model.Element

addExtension, addExtension, copyValues, getExtension, getExtensionsByUrl, getExtensionString, getId, getIdElement, hasExtension, hasExtension, hasId, hasIdElement, setId, setIdElement

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

castToAddress, castToAnnotation, castToAttachment, castToBase64Binary, castToBoolean, castToCode, castToCodeableConcept, castToCoding, castToContactPoint, castToDate, castToDateTime, castToDecimal, castToDuration, castToElementDefinition, castToExtension, castToHumanName, castToId, castToIdentifier, castToInstant, castToInteger, castToMarkdown, castToMeta, castToMoney, castToNarrative, castToOid, castToPeriod, castToPositiveInt, castToQuantity, castToRange, castToRatio, castToReference, castToResource, castToSampledData, castToSignature, castToSimpleQuantity, castToString, castToTime, castToTiming, castToUnsignedInt, castToUri, children, compareDeep, compareDeep, compareDeep, compareValues, compareValues, equals, getChildByName, getFormatCommentsPost, getFormatCommentsPre, getUserData, getUserInt, getUserString, hasFormatComment, hasType, hasUserData, isMetadataBased, isPrimitive, 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 Detail

role

protected Coding role

The function of the agent with respect to the activity.

actor

protected Reference actor

The individual, device or organization that participated in the event.

actorTarget

protected Resource actorTarget

The actual object that is the target of the reference (The individual, device or organization that participated in the event.)

userId

protected Identifier userId

The identity of the agent as known by the authorization system.

relatedAgent

protected List<Provenance.ProvenanceAgentRelatedAgentComponent> relatedAgent

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.

Constructor Detail

ProvenanceAgentComponent

public ProvenanceAgentComponent()

ProvenanceAgentComponent

public ProvenanceAgentComponent(Coding role)

Method Detail

getRole

public Coding getRole()

Returns:

role (The function of the agent with respect to the activity.)

hasRole

public boolean hasRole()

setRole

public Provenance.ProvenanceAgentComponent setRole(Coding value)

Parameters:

value - role (The function of the agent with respect to the activity.)

getActor

public Reference getActor()

Returns:

actor (The individual, device or organization that participated in the event.)

hasActor

public boolean hasActor()

setActor

public Provenance.ProvenanceAgentComponent setActor(Reference value)

Parameters:

value - actor (The individual, device or organization that participated in the event.)

getActorTarget

public Resource getActorTarget()

Returns:

actor 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. (The individual, device or organization that participated in the event.)

setActorTarget

public Provenance.ProvenanceAgentComponent setActorTarget(Resource value)

Parameters:

value - actor 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. (The individual, device or organization that participated in the event.)

getUserId

public Identifier getUserId()

Returns:

userId (The identity of the agent as known by the authorization system.)

hasUserId

public boolean hasUserId()

setUserId

public Provenance.ProvenanceAgentComponent setUserId(Identifier value)

Parameters:

value - userId (The identity of the agent as known by the authorization system.)

getRelatedAgent

public List<Provenance.ProvenanceAgentRelatedAgentComponent> getRelatedAgent()

Returns:

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

hasRelatedAgent

public boolean hasRelatedAgent()

addRelatedAgent

public Provenance.ProvenanceAgentRelatedAgentComponent addRelatedAgent()

Returns:

relatedAgent (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.ProvenanceAgentComponent addRelatedAgent(Provenance.ProvenanceAgentRelatedAgentComponent t)

listChildren

protected void listChildren(List<Property> childrenList)

Overrides:

listChildren in class BackboneElement

setProperty

public void setProperty(String name,
                        Base value)
                 throws org.hl7.fhir.exceptions.FHIRException

Overrides:

setProperty 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 Provenance.ProvenanceAgentComponent copy()

Specified by:

copy in class BackboneElement

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