ca.uhn.fhir.model.dstu2.composite

Class IdentifierDt

java.lang.Object

ca.uhn.fhir.model.api.BaseElement

ca.uhn.fhir.model.api.BaseIdentifiableElement

ca.uhn.fhir.model.base.composite.BaseIdentifierDt

ca.uhn.fhir.model.dstu2.composite.IdentifierDt

All Implemented Interfaces:

ca.uhn.fhir.model.api.ICompositeDatatype, ca.uhn.fhir.model.api.ICompositeElement, ca.uhn.fhir.model.api.IDatatype, ca.uhn.fhir.model.api.IElement, ca.uhn.fhir.model.api.IIdentifiableElement, ca.uhn.fhir.model.api.IQueryParameterType, ca.uhn.fhir.model.api.ISupportsUndeclaredExtensions, Serializable, org.hl7.fhir.instance.model.api.IBase, org.hl7.fhir.instance.model.api.IBaseDatatype, org.hl7.fhir.instance.model.api.ICompositeType

public class IdentifierDt
extends ca.uhn.fhir.model.base.composite.BaseIdentifierDt
implements ca.uhn.fhir.model.api.ICompositeDatatype

HAPI/FHIR IdentifierDt Datatype ()

Definition: A technical identifier - identifies some entity uniquely and unambiguously

Requirements: Need to be able to identify things with confidence and be sure that the identification is not subject to misinterpretation

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
IdentifierDt() Constructor
IdentifierDt(String theSystem, String theValue) Creates a new identifier with the given system and value

Method Summary

Modifier and Type	Method and Description
<T extends ca.uhn.fhir.model.api.IElement> List<T>	getAllPopulatedChildElementsOfType(Class<T> theType)
ResourceReferenceDt	getAssigner() Gets the value(s) for assigner ().
PeriodDt	getPeriod() Gets the value(s) for period ().
String	getSystem() Gets the value(s) for system ().
ca.uhn.fhir.model.primitive.UriDt	getSystemElement() Gets the value(s) for system ().
BoundCodeableConceptDt<IdentifierTypeCodesEnum>	getType() Gets the value(s) for type ().
String	getUse() Gets the value(s) for use ().
ca.uhn.fhir.model.primitive.BoundCodeDt<IdentifierUseEnum>	getUseElement() Gets the value(s) for use ().
String	getValue() Gets the value(s) for value ().
ca.uhn.fhir.model.primitive.StringDt	getValueElement() Gets the value(s) for value ().
boolean	isEmpty()
IdentifierDt	setAssigner(ResourceReferenceDt theValue) Sets the value(s) for assigner ()
IdentifierDt	setPeriod(PeriodDt theValue) Sets the value(s) for period ()
IdentifierDt	setSystem(String theUri) Sets the value for system ()
IdentifierDt	setSystem(ca.uhn.fhir.model.primitive.UriDt theValue) Sets the value(s) for system ()
IdentifierDt	setType(BoundCodeableConceptDt<IdentifierTypeCodesEnum> theValue) Sets the value(s) for type ()
IdentifierDt	setType(IdentifierTypeCodesEnum theValue) Sets the value(s) for type ()
IdentifierDt	setUse(ca.uhn.fhir.model.primitive.BoundCodeDt<IdentifierUseEnum> theValue) Sets the value(s) for use ()
IdentifierDt	setUse(IdentifierUseEnum theValue) Sets the value(s) for use ()
IdentifierDt	setValue(String theString) Sets the value for value ()
IdentifierDt	setValue(ca.uhn.fhir.model.primitive.StringDt theValue) Sets the value(s) for value ()
String	toString()

Methods inherited from class ca.uhn.fhir.model.base.composite.BaseIdentifierDt

getMissing, getQueryParameterQualifier, getValueAsQueryToken, matchesSystemAndValue, setMissing, setValueAsQueryToken

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, getFormatCommentsPost, getFormatCommentsPre, getUndeclaredExtensions, getUndeclaredExtensionsByUrl, getUndeclaredModifierExtensions, hasFormatComment, isBaseEmpty

Methods inherited from class java.lang.Object

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

Constructor Detail

IdentifierDt

public IdentifierDt()

Constructor

IdentifierDt

public IdentifierDt(String theSystem,
                    String theValue)

Creates a new identifier with the given system and value

Method Detail

toString

public String toString()

Overrides:

toString in class Object

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface org.hl7.fhir.instance.model.api.IBase

getAllPopulatedChildElementsOfType

public <T extends ca.uhn.fhir.model.api.IElement> List<T> getAllPopulatedChildElementsOfType(Class<T> theType)

Specified by:

getAllPopulatedChildElementsOfType in interface ca.uhn.fhir.model.api.ICompositeElement

getUseElement

public ca.uhn.fhir.model.primitive.BoundCodeDt<IdentifierUseEnum> getUseElement()

Gets the value(s) for use (). creating it if it does not exist. Will not return null.

Definition: The purpose of this identifier

getUse

public String getUse()

Gets the value(s) for use (). creating it if it does not exist. This method may return null.

Definition: The purpose of this identifier

setUse

public IdentifierDt setUse(ca.uhn.fhir.model.primitive.BoundCodeDt<IdentifierUseEnum> theValue)

Sets the value(s) for use ()

Definition: The purpose of this identifier

setUse

public IdentifierDt setUse(IdentifierUseEnum theValue)

Sets the value(s) for use ()

Definition: The purpose of this identifier

getType

public BoundCodeableConceptDt<IdentifierTypeCodesEnum> getType()

Gets the value(s) for type (). creating it if it does not exist. Will not return null.

Definition: A coded type for the identifier that can be used to determine which identifier to use for a specific purpose

setType

public IdentifierDt setType(BoundCodeableConceptDt<IdentifierTypeCodesEnum> theValue)

Sets the value(s) for type ()

Definition: A coded type for the identifier that can be used to determine which identifier to use for a specific purpose

setType

public IdentifierDt setType(IdentifierTypeCodesEnum theValue)

Sets the value(s) for type ()

Definition: A coded type for the identifier that can be used to determine which identifier to use for a specific purpose

getSystemElement

public ca.uhn.fhir.model.primitive.UriDt getSystemElement()

Gets the value(s) for system (). creating it if it does not exist. Will not return null.

Definition: Establishes the namespace in which set of possible id values is unique.

Specified by:

getSystemElement in class ca.uhn.fhir.model.base.composite.BaseIdentifierDt

getSystem

public String getSystem()

Gets the value(s) for system (). creating it if it does not exist. This method may return null.

Definition: Establishes the namespace in which set of possible id values is unique.

setSystem

public IdentifierDt setSystem(ca.uhn.fhir.model.primitive.UriDt theValue)

Sets the value(s) for system ()

Definition: Establishes the namespace in which set of possible id values is unique.

setSystem

public IdentifierDt setSystem(String theUri)

Sets the value for system ()

Definition: Establishes the namespace in which set of possible id values is unique.

Specified by:

setSystem in class ca.uhn.fhir.model.base.composite.BaseIdentifierDt

getValueElement

public ca.uhn.fhir.model.primitive.StringDt getValueElement()

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

Definition: The portion of the identifier typically displayed to the user and which is unique within the context of the system.

Specified by:

getValueElement in class ca.uhn.fhir.model.base.composite.BaseIdentifierDt

getValue

public String getValue()

Gets the value(s) for value (). creating it if it does not exist. This method may return null.

Definition: The portion of the identifier typically displayed to the user and which is unique within the context of the system.

setValue

public IdentifierDt setValue(ca.uhn.fhir.model.primitive.StringDt theValue)

Sets the value(s) for value ()

Definition: The portion of the identifier typically displayed to the user and which is unique within the context of the system.

setValue

public IdentifierDt setValue(String theString)

Sets the value for value ()

Definition: The portion of the identifier typically displayed to the user and which is unique within the context of the system.

Specified by:

setValue in class ca.uhn.fhir.model.base.composite.BaseIdentifierDt

getPeriod

public PeriodDt getPeriod()

Gets the value(s) for period (). creating it if it does not exist. Will not return null.

Definition: Time period during which identifier is/was valid for use

setPeriod

public IdentifierDt setPeriod(PeriodDt theValue)

Sets the value(s) for period ()

Definition: Time period during which identifier is/was valid for use

getAssigner

public ResourceReferenceDt getAssigner()

Gets the value(s) for assigner (). creating it if it does not exist. Will not return null.

Definition: Organization that issued/manages the identifier

setAssigner

public IdentifierDt setAssigner(ResourceReferenceDt theValue)

Sets the value(s) for assigner ()

Definition: Organization that issued/manages the identifier