Class Annotation

All Implemented Interfaces:
ca.uhn.fhir.model.api.IElement, Serializable, org.hl7.fhir.instance.model.api.IBase, org.hl7.fhir.instance.model.api.IBaseDatatype, org.hl7.fhir.instance.model.api.IBaseElement, org.hl7.fhir.instance.model.api.IBaseHasExtensions, org.hl7.fhir.instance.model.api.ICompositeType

public class Annotation
extends Type
implements org.hl7.fhir.instance.model.api.ICompositeType
A text note which also contains information about who made the statement and when.
See Also:
Serialized Form
  • Field Details

    • author

      protected Type author
      The individual responsible for making the annotation.
    • time

      protected DateTimeType time
      Indicates when this particular annotation was made.
    • text

      protected StringType text
      The text of the annotation.
  • Constructor Details

  • Method Details

    • getAuthor

      public Type getAuthor()
      Returns:
      author (The individual responsible for making the annotation.)
    • getAuthorReference

      public Reference getAuthorReference() throws org.hl7.fhir.exceptions.FHIRException
      Returns:
      author (The individual responsible for making the annotation.)
      Throws:
      org.hl7.fhir.exceptions.FHIRException
    • hasAuthorReference

      public boolean hasAuthorReference()
    • getAuthorStringType

      public StringType getAuthorStringType() throws org.hl7.fhir.exceptions.FHIRException
      Returns:
      author (The individual responsible for making the annotation.)
      Throws:
      org.hl7.fhir.exceptions.FHIRException
    • hasAuthorStringType

      public boolean hasAuthorStringType()
    • hasAuthor

      public boolean hasAuthor()
    • setAuthor

      public Annotation setAuthor​(Type value) throws org.hl7.fhir.exceptions.FHIRFormatError
      Parameters:
      value - author (The individual responsible for making the annotation.)
      Throws:
      org.hl7.fhir.exceptions.FHIRFormatError
    • getTimeElement

      Returns:
      time (Indicates when this particular annotation was made.). This is the underlying object with id, value and extensions. The accessor "getTime" gives direct access to the value
    • hasTimeElement

      public boolean hasTimeElement()
    • hasTime

      public boolean hasTime()
    • setTimeElement

      Parameters:
      value - time (Indicates when this particular annotation was made.). This is the underlying object with id, value and extensions. The accessor "getTime" gives direct access to the value
    • getTime

      public Date getTime()
      Returns:
      Indicates when this particular annotation was made.
    • setTime

      public Annotation setTime​(Date value)
      Parameters:
      value - Indicates when this particular annotation was made.
    • getTextElement

      Returns:
      text (The text of the annotation.). This is the underlying object with id, value and extensions. The accessor "getText" gives direct access to the value
    • hasTextElement

      public boolean hasTextElement()
    • hasText

      public boolean hasText()
    • setTextElement

      Parameters:
      value - text (The text of the annotation.). This is the underlying object with id, value and extensions. The accessor "getText" gives direct access to the value
    • getText

      public String getText()
      Returns:
      The text of the annotation.
    • setText

      public Annotation setText​(String value)
      Parameters:
      value - The text of the annotation.
    • listChildren

      protected void listChildren​(List<Property> children)
      Overrides:
      listChildren in class Element
    • getNamedProperty

      public Property getNamedProperty​(int _hash, String _name, boolean _checkValid) throws org.hl7.fhir.exceptions.FHIRException
      Overrides:
      getNamedProperty in class Element
      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 Element
      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 Element
      Throws:
      org.hl7.fhir.exceptions.FHIRException
    • setProperty

      public Base setProperty​(String name, Base value) throws org.hl7.fhir.exceptions.FHIRException
      Overrides:
      setProperty in class Element
      Throws:
      org.hl7.fhir.exceptions.FHIRException
    • makeProperty

      public Base makeProperty​(int hash, String name) throws org.hl7.fhir.exceptions.FHIRException
      Overrides:
      makeProperty in class Element
      Throws:
      org.hl7.fhir.exceptions.FHIRException
    • getTypesForProperty

      public String[] getTypesForProperty​(int hash, String name) throws org.hl7.fhir.exceptions.FHIRException
      Overrides:
      getTypesForProperty in class Element
      Throws:
      org.hl7.fhir.exceptions.FHIRException
    • addChild

      public Base addChild​(String name) throws org.hl7.fhir.exceptions.FHIRException
      Overrides:
      addChild in class Element
      Throws:
      org.hl7.fhir.exceptions.FHIRException
    • fhirType

      public String fhirType()
      Specified by:
      fhirType in interface org.hl7.fhir.instance.model.api.IBase
      Overrides:
      fhirType in class Element
    • copy

      public Annotation copy()
      Overrides:
      copy in class Type
    • typedCopy

      protected Annotation typedCopy()
      Specified by:
      typedCopy in class Type
    • equalsDeep

      public boolean equalsDeep​(Base other_)
      Overrides:
      equalsDeep in class Element
    • equalsShallow

      public boolean equalsShallow​(Base other_)
      Overrides:
      equalsShallow in class Element
    • isEmpty

      public boolean isEmpty()
      Specified by:
      isEmpty in interface org.hl7.fhir.instance.model.api.IBase
      Overrides:
      isEmpty in class Element