Class ContactPoint

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 ContactPoint extends DataType implements org.hl7.fhir.instance.model.api.ICompositeType
Base StructureDefinition for ContactPoint Type: Details for all kinds of technology mediated contact points for a person or organization, including telephone, email, etc.
See Also:
Serialized Form
  • Field Details

    • system

      Telecommunications form for contact point - what communications system is required to make use of the contact.
    • value

      protected StringType value
      The actual contact point details, in a form that is meaningful to the designated communication system (i.e. phone number or email address).
    • use

      Identifies the purpose for the contact point.
    • rank

      protected PositiveIntType rank
      Specifies a preferred order in which to use a set of contacts. ContactPoints with lower rank values are more preferred than those with higher rank values.
    • period

      protected Period period
      Time period when the contact point was/is in use.
  • Constructor Details

  • Method Details

    • getSystemElement

      Returns:
      system (Telecommunications form for contact point - what communications system is required to make use of the contact.). This is the underlying object with id, value and extensions. The accessor "getSystem" gives direct access to the value
    • hasSystemElement

      public boolean hasSystemElement()
    • hasSystem

      public boolean hasSystem()
    • setSystemElement

      Parameters:
      value - system (Telecommunications form for contact point - what communications system is required to make use of the contact.). This is the underlying object with id, value and extensions. The accessor "getSystem" gives direct access to the value
    • getSystem

      Returns:
      Telecommunications form for contact point - what communications system is required to make use of the contact.
    • setSystem

      Parameters:
      value - Telecommunications form for contact point - what communications system is required to make use of the contact.
    • getValueElement

      Returns:
      value (The actual contact point details, in a form that is meaningful to the designated communication system (i.e. phone number or email address).). This is the underlying object with id, value and extensions. The accessor "getValue" gives direct access to the value
    • hasValueElement

      public boolean hasValueElement()
    • hasValue

      public boolean hasValue()
    • setValueElement

      Parameters:
      value - value (The actual contact point details, in a form that is meaningful to the designated communication system (i.e. phone number or email address).). This is the underlying object with id, value and extensions. The accessor "getValue" gives direct access to the value
    • getValue

      public String getValue()
      Returns:
      The actual contact point details, in a form that is meaningful to the designated communication system (i.e. phone number or email address).
    • setValue

      public ContactPoint setValue(String value)
      Parameters:
      value - The actual contact point details, in a form that is meaningful to the designated communication system (i.e. phone number or email address).
    • getUseElement

      Returns:
      use (Identifies the purpose for the contact point.). This is the underlying object with id, value and extensions. The accessor "getUse" gives direct access to the value
    • hasUseElement

      public boolean hasUseElement()
    • hasUse

      public boolean hasUse()
    • setUseElement

      Parameters:
      value - use (Identifies the purpose for the contact point.). This is the underlying object with id, value and extensions. The accessor "getUse" gives direct access to the value
    • getUse

      Returns:
      Identifies the purpose for the contact point.
    • setUse

      Parameters:
      value - Identifies the purpose for the contact point.
    • getRankElement

      Returns:
      rank (Specifies a preferred order in which to use a set of contacts. ContactPoints with lower rank values are more preferred than those with higher rank values.). This is the underlying object with id, value and extensions. The accessor "getRank" gives direct access to the value
    • hasRankElement

      public boolean hasRankElement()
    • hasRank

      public boolean hasRank()
    • setRankElement

      Parameters:
      value - rank (Specifies a preferred order in which to use a set of contacts. ContactPoints with lower rank values are more preferred than those with higher rank values.). This is the underlying object with id, value and extensions. The accessor "getRank" gives direct access to the value
    • getRank

      public int getRank()
      Returns:
      Specifies a preferred order in which to use a set of contacts. ContactPoints with lower rank values are more preferred than those with higher rank values.
    • setRank

      public ContactPoint setRank(int value)
      Parameters:
      value - Specifies a preferred order in which to use a set of contacts. ContactPoints with lower rank values are more preferred than those with higher rank values.
    • getPeriod

      public Period getPeriod()
      Returns:
      period (Time period when the contact point was/is in use.)
    • hasPeriod

      public boolean hasPeriod()
    • setPeriod

      public ContactPoint setPeriod(Period value)
      Parameters:
      value - period (Time period when the contact point was/is in use.)
    • 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 DataType
    • copy

      public ContactPoint copy()
      Specified by:
      copy in class DataType
    • copyValues

      public void copyValues(ContactPoint dst)
    • typedCopy

      protected ContactPoint typedCopy()
    • 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