Package org.hl7.fhir.dstu3.model

Class Provenance.ProvenanceAgentComponent

java.lang.Object

org.hl7.fhir.dstu3.model.Base

org.hl7.fhir.dstu3.model.Element

org.hl7.fhir.dstu3.model.BackboneElement

org.hl7.fhir.dstu3.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 Type	onBehalfOf	The individual, device, or organization for whom the change was made.
protected CodeableConcept	relatedAgentType	The type of relationship between agents.
protected List<CodeableConcept>	role	The function of the agent with respect to the activity.
protected Type	who	The individual, device or organization that participated in the event.

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

modifierExtension

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

extension, id

Constructor Summary

Constructors

Constructor	Description
ProvenanceAgentComponent()	Constructor
ProvenanceAgentComponent(Type who)	Constructor

Method Summary

Modifier and Type	Method	Description
Base	addChild(String name)
CodeableConcept	addRole()
Provenance.ProvenanceAgentComponent	addRole(CodeableConcept t)
Provenance.ProvenanceAgentComponent	copy()
boolean	equalsDeep(Base other_)
boolean	equalsShallow(Base other_)
String	fhirType()
Property	getNamedProperty(int _hash, String _name, boolean _checkValid)
Type	getOnBehalfOf()
Reference	getOnBehalfOfReference()
UriType	getOnBehalfOfUriType()
Base[]	getProperty(int hash, String name, boolean checkValid)
CodeableConcept	getRelatedAgentType()
List<CodeableConcept>	getRole()
CodeableConcept	getRoleFirstRep()
String[]	getTypesForProperty(int hash, String name)
Type	getWho()
Reference	getWhoReference()
UriType	getWhoUriType()
boolean	hasOnBehalfOf()
boolean	hasOnBehalfOfReference()
boolean	hasOnBehalfOfUriType()
boolean	hasRelatedAgentType()
boolean	hasRole()
boolean	hasWho()
boolean	hasWhoReference()
boolean	hasWhoUriType()
boolean	isEmpty()
protected void	listChildren(List<Property> children)
Base	makeProperty(int hash, String name)
Provenance.ProvenanceAgentComponent	setOnBehalfOf(Type value)
Base	setProperty(int hash, String name, Base value)
Base	setProperty(String name, Base value)
Provenance.ProvenanceAgentComponent	setRelatedAgentType(CodeableConcept value)
Provenance.ProvenanceAgentComponent	setRole(List<CodeableConcept> theRole)
Provenance.ProvenanceAgentComponent	setWho(Type value)

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

addModifierExtension, addModifierExtension, copyValues, getModifierExtension, getModifierExtensionFirstRep, hasModifierExtension, setModifierExtension

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

addExtension, addExtension, addExtension, copyValues, getExtension, getExtensionByUrl, getExtensionFirstRep, getExtensionsByUrl, getExtensionString, getId, getIdBase, getIdElement, hasExtension, hasExtension, hasId, hasIdElement, setExtension, setId, setIdBase, setIdElement

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

castToAddress, castToAnnotation, castToAttachment, castToBase64Binary, castToBoolean, castToCode, castToCodeableConcept, castToCoding, castToContactDetail, castToContactPoint, castToContributor, castToDataRequirement, castToDate, castToDateTime, castToDecimal, castToDosage, castToDuration, castToElementDefinition, castToExtension, castToHumanName, castToId, castToIdentifier, castToInstant, castToInteger, castToMarkdown, castToMeta, castToMoney, castToNarrative, castToOid, castToParameterDefinition, castToPeriod, castToPositiveInt, castToQuantity, castToRange, castToRatio, castToReference, castToRelatedArtifact, castToResource, castToSampledData, castToSignature, castToSimpleQuantity, castToString, castToTime, castToTiming, castToTriggerDefinition, castToType, castToUnsignedInt, castToUri, castToUsageContext, castToXhtml, castToXhtmlString, children, clearUserData, compareDeep, compareDeep, compareDeep, compareValues, compareValues, equals, getChildByName, getFormatCommentsPost, getFormatCommentsPre, getNamedProperty, getUserData, getUserInt, getUserString, hasFormatComment, hasPrimitiveValue, hasType, hasUserData, isBooleanPrimitive, isMetadataBased, isPrimitive, isResource, listChildrenByName, 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 Details

role

protected List<CodeableConcept> role

The function of the agent with respect to the activity. The security role enabling the agent with respect to the activity.

who

protected Type who

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

onBehalfOf

protected Type onBehalfOf

The individual, device, or organization for whom the change was made.

relatedAgentType

protected CodeableConcept relatedAgentType

The type of relationship between agents.

Constructor Details

ProvenanceAgentComponent

public ProvenanceAgentComponent()

Constructor

ProvenanceAgentComponent

public ProvenanceAgentComponent(Type who)

Constructor

Method Details

getRole

public List<CodeableConcept> getRole()

Returns:

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

setRole

public Provenance.ProvenanceAgentComponent setRole(List<CodeableConcept> theRole)

Returns:

Returns a reference to this for easy method chaining

hasRole

public boolean hasRole()

addRole

public CodeableConcept addRole()

addRole

public Provenance.ProvenanceAgentComponent addRole(CodeableConcept t)

getRoleFirstRep

public CodeableConcept getRoleFirstRep()

Returns:

The first repetition of repeating field role, creating it if it does not already exist

getWho

public Type getWho()

Returns:

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

getWhoUriType

public UriType getWhoUriType()
                      throws org.hl7.fhir.exceptions.FHIRException

Returns:

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

Throws:

org.hl7.fhir.exceptions.FHIRException

hasWhoUriType

public boolean hasWhoUriType()

getWhoReference

public Reference getWhoReference()
                          throws org.hl7.fhir.exceptions.FHIRException

Returns:

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

Throws:

org.hl7.fhir.exceptions.FHIRException

hasWhoReference

public boolean hasWhoReference()

hasWho

public boolean hasWho()

setWho

public Provenance.ProvenanceAgentComponent setWho(Type value)
                                           throws org.hl7.fhir.exceptions.FHIRFormatError

Parameters:

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

Throws:

org.hl7.fhir.exceptions.FHIRFormatError

getOnBehalfOf

public Type getOnBehalfOf()

Returns:

onBehalfOf (The individual, device, or organization for whom the change was made.)

getOnBehalfOfUriType

public UriType getOnBehalfOfUriType()
                             throws org.hl7.fhir.exceptions.FHIRException

Returns:

onBehalfOf (The individual, device, or organization for whom the change was made.)

Throws:

org.hl7.fhir.exceptions.FHIRException

hasOnBehalfOfUriType

public boolean hasOnBehalfOfUriType()

getOnBehalfOfReference

public Reference getOnBehalfOfReference()
                                 throws org.hl7.fhir.exceptions.FHIRException

Returns:

onBehalfOf (The individual, device, or organization for whom the change was made.)

Throws:

org.hl7.fhir.exceptions.FHIRException

hasOnBehalfOfReference

public boolean hasOnBehalfOfReference()

hasOnBehalfOf

public boolean hasOnBehalfOf()

setOnBehalfOf

public Provenance.ProvenanceAgentComponent setOnBehalfOf(Type value)
                                                  throws org.hl7.fhir.exceptions.FHIRFormatError

Parameters:

value - onBehalfOf (The individual, device, or organization for whom the change was made.)

Throws:

org.hl7.fhir.exceptions.FHIRFormatError

getRelatedAgentType

public CodeableConcept getRelatedAgentType()

Returns:

relatedAgentType (The type of relationship between agents.)

hasRelatedAgentType

public boolean hasRelatedAgentType()

setRelatedAgentType

public Provenance.ProvenanceAgentComponent setRelatedAgentType(CodeableConcept value)

Parameters:

value - relatedAgentType (The type of relationship between agents.)

listChildren

protected void listChildren(List<Property> children)

Overrides:

listChildren in class BackboneElement

getNamedProperty

public Property getNamedProperty(int _hash,
 String _name,
 boolean _checkValid)
                          throws org.hl7.fhir.exceptions.FHIRException

Overrides:

getNamedProperty in class BackboneElement

Throws:

org.hl7.fhir.exceptions.FHIRException

getProperty

public Base[] getProperty(int hash,
 String name,
 boolean checkValid)
                   throws org.hl7.fhir.exceptions.FHIRException

Overrides:

getProperty in class BackboneElement

Throws:

org.hl7.fhir.exceptions.FHIRException

setProperty

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

Overrides:

setProperty in class BackboneElement

Throws:

org.hl7.fhir.exceptions.FHIRException

setProperty

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

Overrides:

setProperty in class BackboneElement

Throws:

org.hl7.fhir.exceptions.FHIRException

makeProperty

public Base makeProperty(int hash,
 String name)
                  throws org.hl7.fhir.exceptions.FHIRException

Overrides:

makeProperty in class BackboneElement

Throws:

org.hl7.fhir.exceptions.FHIRException

getTypesForProperty

public String[] getTypesForProperty(int hash,
 String name)
                             throws org.hl7.fhir.exceptions.FHIRException

Overrides:

getTypesForProperty 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