ca.uhn.fhir.model.dstu.composite

Class ContactDt

java.lang.Object

ca.uhn.fhir.model.api.BaseElement

ca.uhn.fhir.model.api.BaseIdentifiableElement

ca.uhn.fhir.model.dstu.composite.ContactDt

All Implemented Interfaces:

ICompositeDatatype, ICompositeElement, IDatatype, IElement, IIdentifiableElement, ISupportsUndeclaredExtensions

public class ContactDt
extends BaseIdentifiableElement
implements ICompositeDatatype

HAPI/FHIR ContactDt Datatype (Technology mediated contact details (phone, fax, email, etc))

Definition: All kinds of technology mediated contact details for a person or organization, including telephone, email, etc.

Requirements: Need to track phone, fax, mobile, sms numbers, email addresses, twitter tags, etc.

Constructor Summary

Constructors

Constructor and Description
ContactDt() Constructor
ContactDt(ContactUseEnum theContactUse, String theValue) Constructor
ContactDt(String theValue) Constructor

Method Summary

Methods

Modifier and Type	Method and Description
<T extends IElement> List<T>	getAllPopulatedChildElementsOfType(Class<T> theType) Returns a list containing all child elements matching a given type
PeriodDt	getPeriod() Gets the value(s) for period (Time period when the contact was/is in use).
BoundCodeDt<ContactSystemEnum>	getSystem() Gets the value(s) for system (phone | fax | email | url).
BoundCodeDt<ContactUseEnum>	getUse() Gets the value(s) for use (home | work | temp | old | mobile - purpose of this address).
StringDt	getValue() Gets the value(s) for value (The actual contact details).
boolean	isEmpty()
ContactDt	setPeriod(PeriodDt theValue) Sets the value(s) for period (Time period when the contact was/is in use)
ContactDt	setSystem(BoundCodeDt<ContactSystemEnum> theValue) Sets the value(s) for system (phone | fax | email | url)
ContactDt	setSystem(ContactSystemEnum theValue) Sets the value(s) for system (phone | fax | email | url)
ContactDt	setUse(BoundCodeDt<ContactUseEnum> theValue) Sets the value(s) for use (home | work | temp | old | mobile - purpose of this address)
ContactDt	setUse(ContactUseEnum theValue) Sets the value(s) for use (home | work | temp | old | mobile - purpose of this address)
ContactDt	setValue(String theString) Sets the value for value (The actual contact details)
ContactDt	setValue(StringDt theValue) Sets the value(s) for value (The actual contact details)

Methods inherited from class ca.uhn.fhir.model.api.BaseIdentifiableElement

getElementSpecificId, getId, setElementSpecificId, setId, setId

Methods inherited from class ca.uhn.fhir.model.api.BaseElement

addUndeclaredExtension, addUndeclaredExtension, addUndeclaredExtension, getAllUndeclaredExtensions, getUndeclaredExtensions, getUndeclaredExtensionsByUrl, getUndeclaredModifierExtensions, isBaseEmpty

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ContactDt

public ContactDt()

Constructor

ContactDt

public ContactDt(String theValue)

Constructor

ContactDt

public ContactDt(ContactUseEnum theContactUse,
         String theValue)

Constructor

Method Detail

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface IElement

getAllPopulatedChildElementsOfType

public <T extends IElement> List<T> getAllPopulatedChildElementsOfType(Class<T> theType)

Description copied from interface: ICompositeElement

Returns a list containing all child elements matching a given type

Specified by:

getAllPopulatedChildElementsOfType in interface ICompositeElement

Parameters:

theType - The type to match. If set to null, all child elements will be returned

getSystem

public BoundCodeDt<ContactSystemEnum> getSystem()

Gets the value(s) for system (phone | fax | email | url). creating it if it does not exist. Will not return null.

Definition: Telecommunications form for contact - what communications system is required to make use of the contact

setSystem

public ContactDt setSystem(BoundCodeDt<ContactSystemEnum> theValue)

Sets the value(s) for system (phone | fax | email | url)

Definition: Telecommunications form for contact - what communications system is required to make use of the contact

setSystem

public ContactDt setSystem(ContactSystemEnum theValue)

Sets the value(s) for system (phone | fax | email | url)

Definition: Telecommunications form for contact - what communications system is required to make use of the contact

getValue

public StringDt getValue()

Gets the value(s) for value (The actual contact details). creating it if it does not exist. Will not return null.

Definition: The actual contact details, in a form that is meaningful to the designated communication system (i.e. phone number or email address).

setValue

public ContactDt setValue(StringDt theValue)

Sets the value(s) for value (The actual contact details)

Definition: The actual contact details, in a form that is meaningful to the designated communication system (i.e. phone number or email address).

setValue

public ContactDt setValue(String theString)

Sets the value for value (The actual contact details)

Definition: The actual contact details, in a form that is meaningful to the designated communication system (i.e. phone number or email address).

getUse

public BoundCodeDt<ContactUseEnum> getUse()

Gets the value(s) for use (home | work | temp | old | mobile - purpose of this address). creating it if it does not exist. Will not return null.

Definition: Identifies the purpose for the address

setUse

public ContactDt setUse(BoundCodeDt<ContactUseEnum> theValue)

Sets the value(s) for use (home | work | temp | old | mobile - purpose of this address)

Definition: Identifies the purpose for the address

setUse

public ContactDt setUse(ContactUseEnum theValue)

Sets the value(s) for use (home | work | temp | old | mobile - purpose of this address)

Definition: Identifies the purpose for the address

getPeriod

public PeriodDt getPeriod()

Gets the value(s) for period (Time period when the contact was/is in use). creating it if it does not exist. Will not return null.

Definition: Time period when the contact was/is in use

setPeriod

public ContactDt setPeriod(PeriodDt theValue)

Sets the value(s) for period (Time period when the contact was/is in use)

Definition: Time period when the contact was/is in use