ca.uhn.fhir.model.dstu.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.dstu.composite.IdentifierDt

All Implemented Interfaces:

ICompositeDatatype, ICompositeElement, IDatatype, IElement, IIdentifiableElement, IQueryParameterType, ISupportsUndeclaredExtensions

public class IdentifierDt
extends BaseIdentifierDt
implements ICompositeDatatype

HAPI/FHIR IdentifierDt Datatype (An identifier intended for computation)

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

Constructor Summary

Constructors

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

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
ResourceReferenceDt	getAssigner() Gets the value(s) for assigner (Organization that issued id (may be just text)).
StringDt	getLabel() Gets the value(s) for label (Description of identifier).
PeriodDt	getPeriod() Gets the value(s) for period (Time period when id is/was valid for use).
UriDt	getSystem() Gets the value(s) for system (The namespace for the identifier).
BoundCodeDt<IdentifierUseEnum>	getUse() Gets the value(s) for use (usual | official | temp | secondary (If known)).
StringDt	getValue() Gets the value(s) for value (The value that is unique).
boolean	isEmpty()
IdentifierDt	setAssigner(ResourceReferenceDt theValue) Sets the value(s) for assigner (Organization that issued id (may be just text))
IdentifierDt	setLabel(String theString) Sets the value for label (Description of identifier)
IdentifierDt	setLabel(StringDt theValue) Sets the value(s) for label (Description of identifier)
IdentifierDt	setPeriod(PeriodDt theValue) Sets the value(s) for period (Time period when id is/was valid for use)
IdentifierDt	setSystem(String theUri) Sets the value for system (The namespace for the identifier)
IdentifierDt	setSystem(UriDt theValue) Sets the value(s) for system (The namespace for the identifier)
IdentifierDt	setUse(BoundCodeDt<IdentifierUseEnum> theValue) Sets the value(s) for use (usual | official | temp | secondary (If known))
IdentifierDt	setUse(IdentifierUseEnum theValue) Sets the value(s) for use (usual | official | temp | secondary (If known))
IdentifierDt	setValue(String theString) Sets the value for value (The value that is unique)
IdentifierDt	setValue(StringDt theValue) Sets the value(s) for value (The value that is unique)
String	toString()

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

getQueryParameterQualifier, getValueAsQueryToken, matchesSystemAndValue, 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, getUndeclaredExtensions, getUndeclaredExtensionsByUrl, getUndeclaredModifierExtensions, 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

IdentifierDt

public IdentifierDt(IdentifierUseEnum theUse,
            String theSystem,
            String theValue,
            String theLabel)

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 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

getUse

public BoundCodeDt<IdentifierUseEnum> getUse()

Gets the value(s) for use (usual | official | temp | secondary (If known)). creating it if it does not exist. Will not return null.

Definition: The purpose of this identifier

setUse

public IdentifierDt setUse(BoundCodeDt<IdentifierUseEnum> theValue)

Sets the value(s) for use (usual | official | temp | secondary (If known))

Definition: The purpose of this identifier

setUse

public IdentifierDt setUse(IdentifierUseEnum theValue)

Sets the value(s) for use (usual | official | temp | secondary (If known))

Definition: The purpose of this identifier

getLabel

public StringDt getLabel()

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

Definition: A text string for the identifier that can be displayed to a human so they can recognize the identifier

setLabel

public IdentifierDt setLabel(StringDt theValue)

Sets the value(s) for label (Description of identifier)

Definition: A text string for the identifier that can be displayed to a human so they can recognize the identifier

setLabel

public IdentifierDt setLabel(String theString)

Sets the value for label (Description of identifier)

Definition: A text string for the identifier that can be displayed to a human so they can recognize the identifier

getSystem

public UriDt getSystem()

Gets the value(s) for system (The namespace for the identifier). 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:

getSystem in class BaseIdentifierDt

setSystem

public IdentifierDt setSystem(UriDt theValue)

Sets the value(s) for system (The namespace for the identifier)

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

setSystem

public IdentifierDt setSystem(String theUri)

Sets the value for system (The namespace for the identifier)

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

Specified by:

setSystem in class BaseIdentifierDt

getValue

public StringDt getValue()

Gets the value(s) for value (The value that is unique). 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:

getValue in class BaseIdentifierDt

setValue

public IdentifierDt setValue(StringDt theValue)

Sets the value(s) for value (The value that is unique)

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 (The value that is unique)

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 BaseIdentifierDt

getPeriod

public PeriodDt getPeriod()

Gets the value(s) for period (Time period when id is/was valid for use). 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 (Time period when id is/was valid for use)

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

getAssigner

public ResourceReferenceDt getAssigner()

Gets the value(s) for assigner (Organization that issued id (may be just text)). 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 (Organization that issued id (may be just text))

Definition: Organization that issued/manages the identifier