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

      • 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).
      • 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.
    • Method Detail

      • getSystemElement

        public Enumeration<ContactPoint.ContactPointSystemgetSystemElement()
        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
      • getValueElement

        public StringType 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
      • setValueElement

        public ContactPoint setValueElement​(StringType value)
        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).
      • hasUse

        public boolean hasUse()
      • getRankElement

        public PositiveIntType 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
      • hasRank

        public boolean hasRank()
      • setRankElement

        public ContactPoint setRankElement​(PositiveIntType value)
        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.)
      • 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
      • 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
      • isEmpty

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