Package org.hl7.fhir

Class ProvenanceAgent

java.lang.Object

org.hl7.fhir.Element

org.hl7.fhir.BackboneElement

org.hl7.fhir.ProvenanceAgent

All Implemented Interfaces:

org.jvnet.jaxb2_commons.lang.Equals2, org.jvnet.jaxb2_commons.lang.HashCode2, org.jvnet.jaxb2_commons.lang.ToString2

public class ProvenanceAgent
extends BackboneElement
implements org.jvnet.jaxb2_commons.lang.Equals2, org.jvnet.jaxb2_commons.lang.HashCode2, org.jvnet.jaxb2_commons.lang.ToString2

Provenance of a resource is a record that describes entities and processes involved in producing and delivering or otherwise influencing that resource. Provenance provides a critical foundation for assessing authenticity, enabling trust, and allowing reproducibility. Provenance assertions are a form of contextual metadata and can themselves become important records with their own provenance. Provenance statement indicates clinical significance in terms of confidence in authenticity, reliability, and trustworthiness, integrity, and stage in lifecycle (e.g. Document Completion - has the artifact been legally authenticated), all of which may impact security, privacy, and trust policies.

Java class for Provenance.Agent complex type.

The following schema fragment specifies the expected content contained within this class.

 <complexType name="Provenance.Agent">
   <complexContent>
     <extension base="{http://hl7.org/fhir}BackboneElement">
       <sequence>
         <element name="role" type="{http://hl7.org/fhir}Coding"/>
         <element name="actor" type="{http://hl7.org/fhir}Reference" minOccurs="0"/>
         <element name="userId" type="{http://hl7.org/fhir}Identifier" minOccurs="0"/>
         <element name="relatedAgent" type="{http://hl7.org/fhir}Provenance.RelatedAgent" maxOccurs="unbounded" minOccurs="0"/>
       </sequence>
     </extension>
   </complexContent>
 </complexType>
 

Field Summary

Fields

Modifier and Type	Field	Description
protected Reference	actor
protected List<ProvenanceRelatedAgent>	relatedAgent
protected Coding	role
protected Identifier	userId

Fields inherited from class org.hl7.fhir.BackboneElement

modifierExtension

Fields inherited from class org.hl7.fhir.Element

extension, id

Constructor Summary

Constructors

Constructor	Description
ProvenanceAgent()

Method Summary

Modifier and Type	Method	Description
StringBuilder	append(org.jvnet.jaxb2_commons.locator.ObjectLocator locator, StringBuilder buffer, org.jvnet.jaxb2_commons.lang.ToStringStrategy2 strategy)
StringBuilder	appendFields(org.jvnet.jaxb2_commons.locator.ObjectLocator locator, StringBuilder buffer, org.jvnet.jaxb2_commons.lang.ToStringStrategy2 strategy)
boolean	equals(Object object)
boolean	equals(org.jvnet.jaxb2_commons.locator.ObjectLocator thisLocator, org.jvnet.jaxb2_commons.locator.ObjectLocator thatLocator, Object object, org.jvnet.jaxb2_commons.lang.EqualsStrategy2 strategy)
Reference	getActor()	Gets the value of the actor property.
List<ProvenanceRelatedAgent>	getRelatedAgent()	Gets the value of the relatedAgent property.
Coding	getRole()	Gets the value of the role property.
Identifier	getUserId()	Gets the value of the userId property.
int	hashCode()
int	hashCode(org.jvnet.jaxb2_commons.locator.ObjectLocator locator, org.jvnet.jaxb2_commons.lang.HashCodeStrategy2 strategy)
void	setActor(Reference value)	Sets the value of the actor property.
void	setRelatedAgent(List<ProvenanceRelatedAgent> value)
void	setRole(Coding value)	Sets the value of the role property.
void	setUserId(Identifier value)	Sets the value of the userId property.
String	toString()
ProvenanceAgent	withActor(Reference value)
ProvenanceAgent	withExtension(Collection<Extension> values)
ProvenanceAgent	withExtension(Extension... values)
ProvenanceAgent	withId(String value)
ProvenanceAgent	withModifierExtension(Collection<Extension> values)
ProvenanceAgent	withModifierExtension(Extension... values)
ProvenanceAgent	withRelatedAgent(Collection<ProvenanceRelatedAgent> values)
ProvenanceAgent	withRelatedAgent(ProvenanceRelatedAgent... values)
ProvenanceAgent	withRole(Coding value)
ProvenanceAgent	withUserId(Identifier value)

Methods inherited from class org.hl7.fhir.BackboneElement

getModifierExtension, setModifierExtension

Methods inherited from class org.hl7.fhir.Element

getExtension, getId, setExtension, setId

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

role

protected Coding role

actor

protected Reference actor

userId

protected Identifier userId

relatedAgent

protected List<ProvenanceRelatedAgent> relatedAgent

Constructor Details

ProvenanceAgent

public ProvenanceAgent()

Method Details

getRole

public Coding getRole()

Gets the value of the role property.

Returns:

possible object is Coding

setRole

public void setRole(Coding value)

Sets the value of the role property.

Parameters:

value - allowed object is Coding

getActor

public Reference getActor()

Gets the value of the actor property.

Returns:

possible object is Reference

setActor

public void setActor(Reference value)

Sets the value of the actor property.

Parameters:

value - allowed object is Reference

getUserId

public Identifier getUserId()

Gets the value of the userId property.

Returns:

possible object is Identifier

setUserId

public void setUserId(Identifier value)

Sets the value of the userId property.

Parameters:

value - allowed object is Identifier

getRelatedAgent

public List<ProvenanceRelatedAgent> getRelatedAgent()

Gets the value of the relatedAgent property.

This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the Jakarta XML Binding object. This is why there is not a set method for the relatedAgent property.

For example, to add a new item, do as follows:

    getRelatedAgent().add(newItem);
 

Objects of the following type(s) are allowed in the list ProvenanceRelatedAgent

withRole

public ProvenanceAgent withRole(Coding value)

withActor

public ProvenanceAgent withActor(Reference value)

withUserId

public ProvenanceAgent withUserId(Identifier value)

withRelatedAgent

public ProvenanceAgent withRelatedAgent(ProvenanceRelatedAgent... values)

withRelatedAgent

public ProvenanceAgent withRelatedAgent(Collection<ProvenanceRelatedAgent> values)

withModifierExtension

public ProvenanceAgent withModifierExtension(Extension... values)

Overrides:

withModifierExtension in class BackboneElement

withModifierExtension

public ProvenanceAgent withModifierExtension(Collection<Extension> values)

Overrides:

withModifierExtension in class BackboneElement

withExtension

public ProvenanceAgent withExtension(Extension... values)

Overrides:

withExtension in class BackboneElement

withExtension

public ProvenanceAgent withExtension(Collection<Extension> values)

Overrides:

withExtension in class BackboneElement

withId

public ProvenanceAgent withId(String value)

Overrides:

withId in class BackboneElement

equals

public boolean equals(org.jvnet.jaxb2_commons.locator.ObjectLocator thisLocator,
 org.jvnet.jaxb2_commons.locator.ObjectLocator thatLocator,
 Object object,
 org.jvnet.jaxb2_commons.lang.EqualsStrategy2 strategy)

Specified by:

equals in interface org.jvnet.jaxb2_commons.lang.Equals2

Overrides:

equals in class BackboneElement

equals

public boolean equals(Object object)

Overrides:

equals in class BackboneElement

hashCode

public int hashCode(org.jvnet.jaxb2_commons.locator.ObjectLocator locator,
 org.jvnet.jaxb2_commons.lang.HashCodeStrategy2 strategy)

Specified by:

hashCode in interface org.jvnet.jaxb2_commons.lang.HashCode2

Overrides:

hashCode in class BackboneElement

hashCode

public int hashCode()

Overrides:

hashCode in class BackboneElement

toString

public String toString()

Overrides:

toString in class BackboneElement

append

public StringBuilder append(org.jvnet.jaxb2_commons.locator.ObjectLocator locator,
 StringBuilder buffer,
 org.jvnet.jaxb2_commons.lang.ToStringStrategy2 strategy)

Specified by:

append in interface org.jvnet.jaxb2_commons.lang.ToString2

Overrides:

append in class BackboneElement

appendFields

public StringBuilder appendFields(org.jvnet.jaxb2_commons.locator.ObjectLocator locator,
 StringBuilder buffer,
 org.jvnet.jaxb2_commons.lang.ToStringStrategy2 strategy)

Specified by:

appendFields in interface org.jvnet.jaxb2_commons.lang.ToString2

Overrides:

appendFields in class BackboneElement

setRelatedAgent

public void setRelatedAgent(List<ProvenanceRelatedAgent> value)