org.openmrs

Class PatientIdentifier

java.lang.Object

org.openmrs.BaseOpenmrsObject

org.openmrs.BaseOpenmrsData

org.openmrs.BaseChangeableOpenmrsData

org.openmrs.PatientIdentifier

All Implemented Interfaces:

Serializable, Cloneable, Comparable<PatientIdentifier>, Auditable, Changeable, Creatable, OpenmrsData, OpenmrsObject, Voidable

@Indexed
public class PatientIdentifier
extends BaseChangeableOpenmrsData
implements Serializable, Cloneable, Comparable<PatientIdentifier>

A Patient can have zero to n identifying PatientIdentifier(s). PatientIdentifiers are anything from medical record numbers, to social security numbers, to driver's licenses. The type of identifier is defined by the PatientIdentifierType. A PatientIdentifier also contains a Location.

See Also:

PatientIdentifierType, Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	PatientIdentifier.DefaultComparator Provides a default comparator.

Field Summary

Fields

Modifier and Type	Field and Description
static long	serialVersionUID

Fields inherited from class org.openmrs.BaseOpenmrsData

creator

Constructor Summary

Constructors

Constructor and Description
PatientIdentifier() default constructor
PatientIdentifier(String identifier, PatientIdentifierType type, Location location) Convenience constructor for creating a basic identifier

Method Summary

Modifier and Type	Method and Description
Object	clone() bitwise copy of the PatientIdentifier object.
int	compareTo(PatientIdentifier other) Deprecated. since 1.12. Use DefaultComparator instead. Note: this comparator imposes orderings that are inconsistent with equals.
boolean	equalsContent(PatientIdentifier otherIdentifier) Compares this PatientIdentifier object to the given otherIdentifier.
Integer	getId()
String	getIdentifier()
PatientIdentifierType	getIdentifierType()
Location	getLocation()
Patient	getPatient()
Integer	getPatientIdentifierId()
PatientProgram	getPatientProgram() Gets patient program associated to the identifier in context
Boolean	getPreferred()
Boolean	isPreferred() Deprecated. as of 2.0, use getPreferred()
void	setId(Integer id)
void	setIdentifier(String identifier)
void	setIdentifierType(PatientIdentifierType identifierType)
void	setLocation(Location location)
void	setPatient(Patient patient)
void	setPatientIdentifierId(Integer patientIdentifierId)
void	setPatientProgram(PatientProgram patientProgram) This method sets the patient program on a patient Identifier
void	setPreferred(Boolean preferred)
String	toString() Returns a string equal to the value of: ClassName{hashCode=..., uuid=...}

Methods inherited from class org.openmrs.BaseOpenmrsData

getChangedBy, getCreator, getDateChanged, getDateCreated, getDateVoided, getVoided, getVoidedBy, getVoidReason, isVoided, setChangedBy, setCreator, setDateChanged, setDateCreated, setDateVoided, setVoided, setVoidedBy, setVoidReason

Methods inherited from class org.openmrs.BaseOpenmrsObject

equals, getUuid, hashCode, setUuid

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.openmrs.OpenmrsObject

getUuid, setUuid

Field Detail

serialVersionUID

public static final long serialVersionUID

See Also:

Constant Field Values

Constructor Detail

PatientIdentifier

public PatientIdentifier()

default constructor

PatientIdentifier

public PatientIdentifier(String identifier,
                         PatientIdentifierType type,
                         Location location)

Convenience constructor for creating a basic identifier

Parameters:

identifier - String identifier

type - PatientIdentifierType

location - Location of the identifier

Method Detail

equalsContent

public boolean equalsContent(PatientIdentifier otherIdentifier)

Compares this PatientIdentifier object to the given otherIdentifier. This method differs from BaseOpenmrsObject.equals(Object) in that this method compares the inner fields of each identifier for equality. Note: Null/empty fields on otherIdentifier /will not/ cause a false value to be returned

Parameters:

otherIdentifier - PatientiIdentifier with which to compare

Returns:

boolean true/false whether or not they are the same names

getIdentifier

public String getIdentifier()

Returns:

Returns the identifier.

setIdentifier

public void setIdentifier(String identifier)

Parameters:

identifier - The identifier to set.

getIdentifierType

public PatientIdentifierType getIdentifierType()

Returns:

Returns the identifierType.

setIdentifierType

public void setIdentifierType(PatientIdentifierType identifierType)

Parameters:

identifierType - The identifierType to set.

getLocation

public Location getLocation()

Returns:

Returns the location.

setLocation

public void setLocation(Location location)

Parameters:

location - The location to set.

getPatient

public Patient getPatient()

Returns:

Returns the patient.

setPatient

public void setPatient(Patient patient)

Parameters:

patient - The patient to set.

toString

public String toString()

Description copied from class: BaseOpenmrsObject

Returns a string equal to the value of:

ClassName{hashCode=..., uuid=...}

If the uuid field is null, it returns:

ClassName{hashCode=...}

Should include hashCode if uuid is null Should include uuid if not null

Overrides:

toString in class BaseOpenmrsObject

getPreferred

public Boolean getPreferred()

Returns:

Returns the preferred.

setPreferred

public void setPreferred(Boolean preferred)

Parameters:

preferred - The preferred to set.

isPreferred

@Deprecated
public Boolean isPreferred()

Deprecated. as of 2.0, use getPreferred()

Returns:

the preferred status

compareTo

@Deprecated
public int compareTo(PatientIdentifier other)

Deprecated. since 1.12. Use DefaultComparator instead. Note: this comparator imposes orderings that are inconsistent with equals.

Specified by:

compareTo in interface Comparable<PatientIdentifier>

See Also:

Comparable.compareTo(java.lang.Object)

getId

public Integer getId()

Specified by:

getId in interface OpenmrsObject

Returns:

id - The unique Identifier for the object

Since:

1.5

See Also:

OpenmrsObject.getId()

setId

public void setId(Integer id)

Specified by:

setId in interface OpenmrsObject

Parameters:

id - - The unique Identifier for the object

Since:

1.5

See Also:

OpenmrsObject.setId(java.lang.Integer)

getPatientIdentifierId

public Integer getPatientIdentifierId()

Returns:

the patientIdentifierId

Since:

1.5

setPatientIdentifierId

public void setPatientIdentifierId(Integer patientIdentifierId)

Parameters:

patientIdentifierId - the patientIdentifierId to set

Since:

1.5

clone

public Object clone()

bitwise copy of the PatientIdentifier object. NOTICE: THIS WILL NOT COPY THE PATIENT OBJECT. The PatientIdentifier.patient object in this object AND the cloned object will point at the same patient

Overrides:

clone in class Object

Returns:

New PatientIdentifier object

Since:

2.2.0

getPatientProgram

public PatientProgram getPatientProgram()

Gets patient program associated to the identifier in context

Returns:

patientProgram the patient program associated to an identifier

Since:

2.6.0

setPatientProgram

public void setPatientProgram(PatientProgram patientProgram)

This method sets the patient program on a patient Identifier

Parameters:

patientProgram - The patientProgram to set.

Since:

2.6.0