ContactPoint (org.hl7.fhir.r4 5.4.0 API)

java.lang.Object
- org.hl7.fhir.r4.model.Base
- - org.hl7.fhir.r4.model.Element
  - - org.hl7.fhir.r4.model.Type
    - - org.hl7.fhir.r4.model.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

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`ContactPoint.ContactPointSystem`
`static class`	`ContactPoint.ContactPointSystemEnumFactory`
`static class`	`ContactPoint.ContactPointUse`
`static class`	`ContactPoint.ContactPointUseEnumFactory`

Field Summary

Fields
Modifier and Type	Field and Description
`protected Period`	`period` Time period when the contact point was/is in use.
`protected PositiveIntType`	`rank` Specifies a preferred order in which to use a set of contacts.
`protected Enumeration<ContactPoint.ContactPointSystem>`	`system` Telecommunications form for contact point - what communications system is required to make use of the contact.
`protected Enumeration<ContactPoint.ContactPointUse>`	`use` Identifies the purpose for the contact point.
`protected StringType`	`value` The actual contact point details, in a form that is meaningful to the designated communication system (i.e.

Fields inherited from class org.hl7.fhir.r4.model.Element
extension, id

Constructor Summary

Constructors
Constructor and Description

ContactPoint()
Constructor

Constructors
Constructor and Description
`ContactPoint()` Constructor

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Base`	`addChild(String name)`
`ContactPoint`	`copy()`
`void`	`copyValues(ContactPoint dst)`
`boolean`	`equalsDeep(Base other_)`
`boolean`	`equalsShallow(Base other_)`
`String`	`fhirType()`
`Property`	`getNamedProperty(int _hash, String _name, boolean _checkValid)`
`Period`	`getPeriod()`
`Base[]`	`getProperty(int hash, String name, boolean checkValid)`
`int`	`getRank()`
`PositiveIntType`	`getRankElement()`
`ContactPoint.ContactPointSystem`	`getSystem()`
`Enumeration<ContactPoint.ContactPointSystem>`	`getSystemElement()`
`String[]`	`getTypesForProperty(int hash, String name)`
`ContactPoint.ContactPointUse`	`getUse()`
`Enumeration<ContactPoint.ContactPointUse>`	`getUseElement()`
`String`	`getValue()`
`StringType`	`getValueElement()`
`boolean`	`hasPeriod()`
`boolean`	`hasRank()`
`boolean`	`hasRankElement()`
`boolean`	`hasSystem()`
`boolean`	`hasSystemElement()`
`boolean`	`hasUse()`
`boolean`	`hasUseElement()`
`boolean`	`hasValue()`
`boolean`	`hasValueElement()`
`boolean`	`isEmpty()`
`protected void`	`listChildren(List<Property> children)`
`Base`	`makeProperty(int hash, String name)`
`ContactPoint`	`setPeriod(Period value)`
`Base`	`setProperty(int hash, String name, Base value)`
`Base`	`setProperty(String name, Base value)`
`ContactPoint`	`setRank(int value)`
`ContactPoint`	`setRankElement(PositiveIntType value)`
`ContactPoint`	`setSystem(ContactPoint.ContactPointSystem value)`
`ContactPoint`	`setSystemElement(Enumeration<ContactPoint.ContactPointSystem> value)`
`ContactPoint`	`setUse(ContactPoint.ContactPointUse value)`
`ContactPoint`	`setUseElement(Enumeration<ContactPoint.ContactPointUse> value)`
`ContactPoint`	`setValue(String value)`
`ContactPoint`	`setValueElement(StringType value)`
`protected ContactPoint`	`typedCopy()`

Methods inherited from class org.hl7.fhir.r4.model.Element
addExtension, addExtension, addExtension, copyValues, getExtension, getExtensionByUrl, getExtensionFirstRep, getExtensionsByUrl, getExtensionString, getId, getIdBase, getIdElement, hasExtension, hasExtension, hasId, hasIdElement, isDisallowExtensions, noExtensions, removeExtension, setDisallowExtensions, setExtension, setId, setIdBase, setIdElement

Methods inherited from class org.hl7.fhir.r4.model.Base
castToAddress, castToAnnotation, castToAttachment, castToBase64Binary, castToBoolean, castToCanonical, castToCode, castToCodeableConcept, castToCoding, castToContactDetail, castToContactPoint, castToContributor, castToDataRequirement, castToDate, castToDateTime, castToDecimal, castToDosage, castToDuration, castToElementDefinition, castToExpression, castToExtension, castToHumanName, castToId, castToIdentifier, castToInstant, castToInteger, castToMarkdown, castToMarketingStatus, castToMeta, castToMoney, castToNarrative, castToOid, castToParameterDefinition, castToPeriod, castToPopulation, castToPositiveInt, castToProdCharacteristic, castToProductShelfLife, castToQuantity, castToRange, castToRatio, castToReference, castToRelatedArtifact, castToResource, castToSampledData, castToSignature, castToSimpleQuantity, castToString, castToSubstanceAmount, castToTime, castToTiming, castToTriggerDefinition, castToType, castToUnsignedInt, castToUri, castToUrl, castToUsageContext, castToXhtml, castToXhtmlString, children, clearUserData, compareDeep, compareDeep, compareDeep, compareDeep, compareValues, compareValues, dateTimeValue, equals, getChildByName, getFormatCommentsPost, getFormatCommentsPre, getNamedProperty, getUserData, getUserInt, getUserString, hasFormatComment, hasPrimitiveValue, hasType, hasUserData, isBooleanPrimitive, isDateTime, isMetadataBased, isPrimitive, isResource, listChildrenByName, listChildrenByName, primitiveValue, setUserData, setUserDataINN

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.hl7.fhir.instance.model.api.IBase
getFormatCommentsPost, getFormatCommentsPre, getUserData, hasFormatComment, setUserData

Methods inherited from interface org.hl7.fhir.instance.model.api.IBaseElement
getUserData, setUserData

- Field Detail
  - system
```
protected Enumeration<ContactPoint.ContactPointSystem> 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
```
protected Enumeration<ContactPoint.ContactPointUse> 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 Detail
  - ContactPoint
```
public ContactPoint()
```
    Constructor
- Method Detail
  - getSystemElement
```
public Enumeration<ContactPoint.ContactPointSystem> 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
```
public ContactPoint setSystemElement(Enumeration<ContactPoint.ContactPointSystem> value)
```
    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
```
public ContactPoint.ContactPointSystem getSystem()
```
    Returns:
    
    Telecommunications form for contact point - what communications system is required to make use of the contact.
  - setSystem
```
public ContactPoint setSystem(ContactPoint.ContactPointSystem value)
```
    Parameters:
    
    value - Telecommunications form for contact point - what communications system is required to make use of the contact.
  - 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
  - hasValueElement
```
public boolean hasValueElement()
```
  - hasValue
```
public boolean hasValue()
```
  - 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).
  - getUseElement
```
public Enumeration<ContactPoint.ContactPointUse> 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
```
public ContactPoint setUseElement(Enumeration<ContactPoint.ContactPointUse> value)
```
    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
```
public ContactPoint.ContactPointUse getUse()
```
    Returns:
    
    Identifies the purpose for the contact point.
  - setUse
```
public ContactPoint setUse(ContactPoint.ContactPointUse value)
```
    Parameters:
    
    value - Identifies the purpose for the contact point.
  - 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
  - hasRankElement
```
public boolean hasRankElement()
```
  - 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.)
  - 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 Element
  - copy
```
public ContactPoint copy()
```
    Overrides:
    
    copy in class Type
  - copyValues
```
public void copyValues(ContactPoint dst)
```
  - typedCopy
```
protected ContactPoint 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

Class ContactPoint

Nested Class Summary

Field Summary

Fields inherited from class org.hl7.fhir.r4.model.Element

Constructor Summary

Method Summary

Methods inherited from class org.hl7.fhir.r4.model.Element

Methods inherited from class org.hl7.fhir.r4.model.Base

Methods inherited from class java.lang.Object

Methods inherited from interface org.hl7.fhir.instance.model.api.IBase

Methods inherited from interface org.hl7.fhir.instance.model.api.IBaseElement

Field Detail

system

value

use

rank

period

Constructor Detail

ContactPoint

Method Detail

getSystemElement

hasSystemElement

hasSystem

setSystemElement

getSystem

setSystem

getValueElement

hasValueElement

hasValue

setValueElement

getValue

setValue

getUseElement

hasUseElement

hasUse

setUseElement

getUse

setUse

getRankElement

hasRankElement

hasRank

setRankElement

getRank

setRank

getPeriod

hasPeriod

setPeriod

listChildren

getNamedProperty

getProperty

setProperty

setProperty

makeProperty

getTypesForProperty

addChild

fhirType

copy

copyValues

typedCopy

equalsDeep

equalsShallow

isEmpty