Provenance.ProvenanceEntityComponent (HAPI FHIR Structures

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

All Implemented Interfaces:

IElement, Serializable, IBase, IBaseBackboneElement, IBaseElement, IBaseHasExtensions, IBaseHasModifierExtensions

Enclosing class:

Provenance
```
public static class Provenance.ProvenanceEntityComponent
extends BackboneElement
implements IBaseBackboneElement
```
See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field and 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 Type`	`what` Identity of the Entity used.

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 and Description
`ProvenanceEntityComponent()` Constructor
`ProvenanceEntityComponent(Enumeration<Provenance.ProvenanceEntityRole> role, Type what)` Constructor

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Provenance.ProvenanceAgentComponent`	`addAgent()`
`Provenance.ProvenanceEntityComponent`	`addAgent(Provenance.ProvenanceAgentComponent t)`
`Base`	`addChild(String name)`
`Provenance.ProvenanceEntityComponent`	`copy()`
`boolean`	`equalsDeep(Base other)`
`boolean`	`equalsShallow(Base other)`
`String`	`fhirType()`
`List<Provenance.ProvenanceAgentComponent>`	`getAgent()`
`Provenance.ProvenanceAgentComponent`	`getAgentFirstRep()`
`Base[]`	`getProperty(int hash, String name, boolean checkValid)`
`Provenance.ProvenanceEntityRole`	`getRole()`
`Enumeration<Provenance.ProvenanceEntityRole>`	`getRoleElement()`
`String[]`	`getTypesForProperty(int hash, String name)`
`Type`	`getWhat()`
`Identifier`	`getWhatIdentifier()`
`Reference`	`getWhatReference()`
`UriType`	`getWhatUriType()`
`boolean`	`hasAgent()`
`boolean`	`hasRole()`
`boolean`	`hasRoleElement()`
`boolean`	`hasWhat()`
`boolean`	`hasWhatIdentifier()`
`boolean`	`hasWhatReference()`
`boolean`	`hasWhatUriType()`
`boolean`	`isEmpty()`
`protected void`	`listChildren(List<Property> childrenList)`
`Base`	`makeProperty(int hash, String name)`
`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(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, 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, getUserData, getUserInt, getUserString, hasFormatComment, hasPrimitiveValue, hasType, hasUserData, 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, hasFormatComment

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 Enumeration<Provenance.ProvenanceEntityRole> role
```
    How the entity was used during the activity.
  - what
```
protected Type 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 generated the entity.
- Constructor Detail
  - ProvenanceEntityComponent
```
public ProvenanceEntityComponent()
```
    Constructor
  - ProvenanceEntityComponent
```
public ProvenanceEntityComponent(Enumeration<Provenance.ProvenanceEntityRole> role,
                                 Type what)
```
    Constructor
- Method Detail
  - 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 Type getWhat()
```
    Returns:
    
    what (Identity of the Entity used. May be a logical or physical uri and maybe absolute or relative.)
  - getWhatUriType
```
public UriType getWhatUriType()
                       throws FHIRException
```
    Returns:
    
    what (Identity of the Entity used. May be a logical or physical uri and maybe absolute or relative.)
    
    Throws:
    
    FHIRException
  - hasWhatUriType
```
public boolean hasWhatUriType()
```
  - getWhatReference
```
public Reference getWhatReference()
                           throws FHIRException
```
    Returns:
    
    what (Identity of the Entity used. May be a logical or physical uri and maybe absolute or relative.)
    
    Throws:
    
    FHIRException
  - hasWhatReference
```
public boolean hasWhatReference()
```
  - getWhatIdentifier
```
public Identifier getWhatIdentifier()
                             throws FHIRException
```
    Returns:
    
    what (Identity of the Entity used. May be a logical or physical uri and maybe absolute or relative.)
    
    Throws:
    
    FHIRException
  - hasWhatIdentifier
```
public boolean hasWhatIdentifier()
```
  - hasWhat
```
public boolean hasWhat()
```
  - setWhat
```
public Provenance.ProvenanceEntityComponent setWhat(Type 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 generated 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
  - listChildren
```
protected void listChildren(List<Property> childrenList)
```
    Overrides:
    
    listChildren in class BackboneElement
  - getProperty
```
public Base[] getProperty(int hash,
                          String name,
                          boolean checkValid)
                   throws FHIRException
```
    Overrides:
    
    getProperty in class BackboneElement
    
    Throws:
    
    FHIRException
  - setProperty
```
public Base setProperty(int hash,
                        String name,
                        Base value)
                 throws FHIRException
```
    Overrides:
    
    setProperty in class BackboneElement
    
    Throws:
    
    FHIRException
  - setProperty
```
public Base setProperty(String name,
                        Base value)
                 throws FHIRException
```
    Overrides:
    
    setProperty in class BackboneElement
    
    Throws:
    
    FHIRException
  - makeProperty
```
public Base makeProperty(int hash,
                         String name)
                  throws FHIRException
```
    Overrides:
    
    makeProperty in class BackboneElement
    
    Throws:
    
    FHIRException
  - getTypesForProperty
```
public String[] getTypesForProperty(int hash,
                                    String name)
                             throws FHIRException
```
    Overrides:
    
    getTypesForProperty in class BackboneElement
    
    Throws:
    
    FHIRException
  - addChild
```
public Base addChild(String name)
              throws FHIRException
```
    Overrides:
    
    addChild in class BackboneElement
    
    Throws:
    
    FHIRException
  - copy
```
public Provenance.ProvenanceEntityComponent 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 IBase
    
    Overrides:
    
    isEmpty in class BackboneElement
  - fhirType
```
public String fhirType()
```
    Overrides:
    
    fhirType in class BackboneElement

Class Provenance.ProvenanceEntityComponent

Field Summary

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

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

Constructor Summary

Method Summary

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

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

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

Methods inherited from class java.lang.Object

Methods inherited from interface org.hl7.fhir.instance.model.api.IBase

Methods inherited from interface org.hl7.fhir.instance.model.api.IBaseHasExtensions

Methods inherited from interface org.hl7.fhir.instance.model.api.IBaseHasModifierExtensions

Field Detail

role

what

agent

Constructor Detail

ProvenanceEntityComponent

ProvenanceEntityComponent

Method Detail

getRoleElement

hasRoleElement

hasRole

setRoleElement

getRole

setRole

getWhat

getWhatUriType

hasWhatUriType

getWhatReference

hasWhatReference

getWhatIdentifier

hasWhatIdentifier

hasWhat

setWhat

getAgent

setAgent

hasAgent

addAgent

addAgent

getAgentFirstRep

listChildren

getProperty

setProperty

setProperty

makeProperty

getTypesForProperty

addChild

copy

equalsDeep

equalsShallow

isEmpty

fhirType