Package org.hl7.fhir.r5.model

Class Provenance.ProvenanceEntityComponent

java.lang.Object

org.hl7.fhir.r5.model.Base

org.hl7.fhir.r5.model.Element

org.hl7.fhir.r5.model.BackboneElement

org.hl7.fhir.r5.model.Provenance.ProvenanceEntityComponent

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.ProvenanceEntityComponent
extends BackboneElement
implements org.hl7.fhir.instance.model.api.IBaseBackboneElement

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class org.hl7.fhir.r5.model.Base

Base.ProfileSource, Base.ValidationInfo, Base.ValidationMode, Base.ValidationReason

Field Summary

Fields

Modifier and Type	Field	Description
protected List<Provenance.ProvenanceAgentComponent>	agent	The entity is attributed to an agent to express the agent's responsibility for that entity, possibly along with other agents.
protected Enumeration<Provenance.ProvenanceEntityRole>	role	How the entity was used during the activity.
protected Reference	what	Identity of the Entity used.

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

modifierExtension

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

extension, id

Constructor Summary

Constructors

Constructor	Description
ProvenanceEntityComponent()	Constructor
ProvenanceEntityComponent(Provenance.ProvenanceEntityRole role, Reference what)	Constructor

Method Summary

Modifier and Type	Method	Description
Provenance.ProvenanceAgentComponent	addAgent()
Provenance.ProvenanceEntityComponent	addAgent(Provenance.ProvenanceAgentComponent t)
Base	addChild(String name)
Provenance.ProvenanceEntityComponent	copy()
void	copyValues(Provenance.ProvenanceEntityComponent dst)
boolean	equalsDeep(Base other_)
boolean	equalsShallow(Base other_)
String	fhirType()
List<Provenance.ProvenanceAgentComponent>	getAgent()
Provenance.ProvenanceAgentComponent	getAgentFirstRep()
Property	getNamedProperty(int _hash, String _name, boolean _checkValid)
Base[]	getProperty(int hash, String name, boolean checkValid)
Provenance.ProvenanceEntityRole	getRole()
Enumeration<Provenance.ProvenanceEntityRole>	getRoleElement()
String[]	getTypesForProperty(int hash, String name)
Reference	getWhat()
boolean	hasAgent()
boolean	hasRole()
boolean	hasRoleElement()
boolean	hasWhat()
boolean	isEmpty()
protected void	listChildren(List<Property> children)
Base	makeProperty(int hash, String name)
void	removeChild(String name, Base value)
Provenance.ProvenanceEntityComponent	setAgent(List<Provenance.ProvenanceAgentComponent> theAgent)
Base	setProperty(int hash, String name, Base value)
Base	setProperty(String name, Base value)
Provenance.ProvenanceEntityComponent	setRole(Provenance.ProvenanceEntityRole value)
Provenance.ProvenanceEntityComponent	setRoleElement(Enumeration<Provenance.ProvenanceEntityRole> value)
Provenance.ProvenanceEntityComponent	setWhat(Reference value)

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

addModifierExtension, addModifierExtension, addModifierExtension, checkNoModifiers, copyExtensions, copyNewExtensions, copyValues, getExtensionByUrl, getExtensionsByUrl, getExtensionsByUrl, getExtensionValue, getModifierExtension, getModifierExtensionFirstRep, hasExtension, hasExtension, hasModifierExtension, removeExtension, setModifierExtension

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

addExtension, addExtension, addExtension, copyExtensions, copyNewExtensions, copyValues, getExtension, getExtensionByUrl, getExtensionFirstRep, getExtensionString, getExtensionString, getFHIRPublicationVersion, getId, getIdBase, getIdElement, getStandardsStatus, hasExtension, hasExtension, hasId, hasIdElement, isDisallowExtensions, noExtensions, setDisallowExtensions, setExtension, setId, setIdBase, setIdElement, setStandardsStatus

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

addDefinition, addFormatCommentsPost, addFormatCommentsPre, addValidationMessage, canHavePrimitiveValue, children, clearUserData, compareDeep, compareDeep, compareDeep, compareDeep, compareValues, compareValues, copyFormatComments, copyUserData, copyValues, dateTimeValue, equals, executeFunction, getChildByName, getChildValueByName, getFormatCommentsPost, getFormatCommentsPre, getNamedProperty, getUserData, getUserInt, getUserString, getValidationInfo, getValidationMessages, getXhtml, hasFormatComment, hasFormatCommentPost, hasFormatCommentPre, hasPrimitiveValue, hasType, hasUserData, hasValidated, hasValidationInfo, hasValidationMessages, isBooleanPrimitive, isCopyUserData, isDateTime, isMetadataBased, isPrimitive, isResource, listChildrenByName, listChildrenByName, primitiveValue, setCopyUserData, setUserData, setUserDataINN, setXhtml

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 Enumeration<Provenance.ProvenanceEntityRole> role

How the entity was used during the activity.

what

protected Reference what

Identity of the Entity used. May be a logical or physical uri and maybe absolute or relative.

agent

protected List<Provenance.ProvenanceAgentComponent> agent

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 used the entity.

Constructor Details

ProvenanceEntityComponent

public ProvenanceEntityComponent()

Constructor

ProvenanceEntityComponent

public ProvenanceEntityComponent(Provenance.ProvenanceEntityRole role,
 Reference what)

Constructor

Method Details

getRoleElement

public Enumeration<Provenance.ProvenanceEntityRole> getRoleElement()

Returns:

role (How the entity was used during the activity.). This is the underlying object with id, value and extensions. The accessor "getRole" gives direct access to the value

hasRoleElement

public boolean hasRoleElement()

hasRole

public boolean hasRole()

setRoleElement

public Provenance.ProvenanceEntityComponent setRoleElement(Enumeration<Provenance.ProvenanceEntityRole> value)

Parameters:

value - role (How the entity was used during the activity.). This is the underlying object with id, value and extensions. The accessor "getRole" gives direct access to the value

getRole

public Provenance.ProvenanceEntityRole getRole()

Returns:

How the entity was used during the activity.

setRole

public Provenance.ProvenanceEntityComponent setRole(Provenance.ProvenanceEntityRole value)

Parameters:

value - How the entity was used during the activity.

getWhat

public Reference getWhat()

Returns:

what (Identity of the Entity used. May be a logical or physical uri and maybe absolute or relative.)

hasWhat

public boolean hasWhat()

setWhat

public Provenance.ProvenanceEntityComponent setWhat(Reference value)

Parameters:

value - what (Identity of the Entity used. May be a logical or physical uri and maybe absolute or relative.)

getAgent

public List<Provenance.ProvenanceAgentComponent> getAgent()

Returns:

agent (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 used the entity.)

setAgent

public Provenance.ProvenanceEntityComponent setAgent(List<Provenance.ProvenanceAgentComponent> theAgent)

Returns:

Returns a reference to this for easy method chaining

hasAgent

public boolean hasAgent()

addAgent

public Provenance.ProvenanceAgentComponent addAgent()

addAgent

public Provenance.ProvenanceEntityComponent addAgent(Provenance.ProvenanceAgentComponent t)

getAgentFirstRep

public Provenance.ProvenanceAgentComponent getAgentFirstRep()

Returns:

The first repetition of repeating field agent, creating it if it does not already exist {3}

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

removeChild

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

Overrides:

removeChild 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.ProvenanceEntityComponent copy()

Specified by:

copy in class BackboneElement

copyValues

public void copyValues(Provenance.ProvenanceEntityComponent dst)

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

Returns:

the FHIR type name of the instance (not the java class name)