Class Provenance.Entity

java.lang.Object
ca.uhn.fhir.model.api.BaseElement
ca.uhn.fhir.model.api.BaseIdentifiableElement
ca.uhn.fhir.model.dstu2.resource.Provenance.Entity
All Implemented Interfaces:
ca.uhn.fhir.model.api.ICompositeElement, ca.uhn.fhir.model.api.IElement, ca.uhn.fhir.model.api.IIdentifiableElement, ca.uhn.fhir.model.api.IResourceBlock, ca.uhn.fhir.model.api.ISupportsUndeclaredExtensions, Serializable, org.hl7.fhir.instance.model.api.IBase
Enclosing class:
Provenance

public static class Provenance.Entity
extends ca.uhn.fhir.model.api.BaseIdentifiableElement
implements ca.uhn.fhir.model.api.IResourceBlock
Block class for child element: Provenance.entity ()

Definition: An entity used in this activity

See Also:
Serialized Form
  • Constructor Details

  • Method Details

    • isEmpty

      public boolean isEmpty()
      Specified by:
      isEmpty in interface org.hl7.fhir.instance.model.api.IBase
    • getAllPopulatedChildElementsOfType

      public <T extends ca.uhn.fhir.model.api.IElement> List<T> getAllPopulatedChildElementsOfType​(Class<T> theType)
      Specified by:
      getAllPopulatedChildElementsOfType in interface ca.uhn.fhir.model.api.ICompositeElement
    • getRoleElement

      public ca.uhn.fhir.model.primitive.BoundCodeDt<ProvenanceEntityRoleEnum> getRoleElement()
      Gets the value(s) for role (). creating it if it does not exist. Will not return null.

      Definition: How the entity was used during the activity

    • getRole

      public String getRole()
      Gets the value(s) for role (). creating it if it does not exist. This method may return null.

      Definition: How the entity was used during the activity

    • setRole

      public Provenance.Entity setRole​(ca.uhn.fhir.model.primitive.BoundCodeDt<ProvenanceEntityRoleEnum> theValue)
      Sets the value(s) for role ()

      Definition: How the entity was used during the activity

    • setRole

      Sets the value(s) for role ()

      Definition: How the entity was used during the activity

    • getType

      public CodingDt getType()
      Gets the value(s) for type (). creating it if it does not exist. Will not return null.

      Definition: The type of the entity. If the entity is a resource, then this is a resource type

    • setType

      public Provenance.Entity setType​(CodingDt theValue)
      Sets the value(s) for type ()

      Definition: The type of the entity. If the entity is a resource, then this is a resource type

    • getReferenceElement

      public ca.uhn.fhir.model.primitive.UriDt getReferenceElement()
      Gets the value(s) for reference (). creating it if it does not exist. Will not return null.

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

    • getReference

      public String getReference()
      Gets the value(s) for reference (). creating it if it does not exist. This method may return null.

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

    • setReference

      public Provenance.Entity setReference​(ca.uhn.fhir.model.primitive.UriDt theValue)
      Sets the value(s) for reference ()

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

    • setReference

      Sets the value for reference ()

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

    • getDisplayElement

      public ca.uhn.fhir.model.primitive.StringDt getDisplayElement()
      Gets the value(s) for display (). creating it if it does not exist. Will not return null.

      Definition: Human-readable description of the entity

    • getDisplay

      public String getDisplay()
      Gets the value(s) for display (). creating it if it does not exist. This method may return null.

      Definition: Human-readable description of the entity

    • setDisplay

      public Provenance.Entity setDisplay​(ca.uhn.fhir.model.primitive.StringDt theValue)
      Sets the value(s) for display ()

      Definition: Human-readable description of the entity

    • setDisplay

      public Provenance.Entity setDisplay​(String theString)
      Sets the value for display ()

      Definition: Human-readable description of the entity

    • getAgent

      Gets the value(s) for agent (). creating it if it does not exist. Will not return null.

      Definition: 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

      Sets the value(s) for agent ()

      Definition: 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