org.openmrs
Class Patient

java.lang.Object
  org.openmrs.Person
      org.openmrs.Patient

All Implemented Interfaces:

java.io.Serializable

public class Patient
extends Person
implements java.io.Serializable

Defines a Patient in the system. A patient is simply an extension of a person and all that that implies.

Version:

2.0

See Also:

Serialized Form

Field Summary

protected static org.apache.commons.logging.Log	log
static long	serialVersionUID

Fields inherited from class org.openmrs.Person

personId

Constructor Summary

Patient()
default constructor

Patient(java.lang.Integer patientId)
Constructor with default patient id

Patient(Person person)

Method Summary

void	addIdentifier(PatientIdentifier patientIdentifier) Will add this PatientIdentifier if the patient doesn't contain it already
void	addIdentifiers(java.util.Collection<PatientIdentifier> patientIdentifiers) Will only add PatientIdentifiers in this list that this patient does not have already
boolean	equals(java.lang.Object obj) Compares two objects for similarity This must pass through to the parent object (org.openmrs.Person) in order to get similarity of person/patient objects
java.util.List<PatientIdentifier>	getActiveIdentifiers() Returns only the non-voided identifiers for this patient.
User	getChangedBy()
User	getCreator()
java.util.Date	getDateChanged()
java.util.Date	getDateCreated()
java.util.Date	getDateVoided()
java.util.Set<PatientIdentifier>	getIdentifiers() Get all of this patients identifiers -- both voided and non-voided ones.
java.lang.Integer	getPatientId()
PatientIdentifier	getPatientIdentifier() Convenience method to get the "preferred" identifier for patient.
PatientIdentifier	getPatientIdentifier(java.lang.Integer identifierTypeId) Return's the first (preferred) patient identifier matching identifierTypeId
PatientIdentifier	getPatientIdentifier(java.lang.String identifierTypeName) Return's the first (preferred) patient identifier matching identifierTypeName
Tribe	getTribe()
java.lang.Boolean	getVoided()
User	getVoidedBy()
java.lang.String	getVoidReason()
int	hashCode() The hashcode for a patient/person is used to index the objects in a tree This must pass through to the parent object (org.openmrs.Person) in order to get similarity of person/patient objects
java.lang.Boolean	isVoided()
void	removeIdentifier(PatientIdentifier patientIdentifier)
void	setChangedBy(User changedBy)
void	setCreator(User creator)
void	setDateChanged(java.util.Date dateChanged)
void	setDateCreated(java.util.Date dateCreated)
void	setDateVoided(java.util.Date dateVoided)
void	setIdentifiers(java.util.Set<PatientIdentifier> identifiers)
void	setPatientId(java.lang.Integer patientId) Sets the internal identifier for a patient.
void	setPersonId(java.lang.Integer personId) Overrides the parent setPersonId(Integer) so that we can be sure patient id is also set correctly.
void	setTribe(Tribe tribe)
void	setVoided(java.lang.Boolean voided)
void	setVoidedBy(User voidedBy)
void	setVoidReason(java.lang.String voidReason)
java.lang.String	toString()

Methods inherited from class org.openmrs.Person

addAddress, addAttribute, addName, getActiveAttributes, getAddresses, getAge, getAge, getAttribute, getAttribute, getAttributeMap, getAttributes, getAttributes, getAttributes, getBirthdate, getBirthdateEstimated, getCauseOfDeath, getDead, getDeathDate, getFamilyName, getGender, getGivenName, getMiddleName, getNames, getPersonAddress, getPersonChangedBy, getPersonCreator, getPersonDateChanged, getPersonDateCreated, getPersonDateVoided, getPersonId, getPersonName, getPersonVoided, getPersonVoidedBy, getPersonVoidReason, isBirthdateEstimated, isDead, isPatient, isPersonVoided, isUser, printAttributes, removeAddress, removeAttribute, removeName, replaceSerialization, setAddresses, setAttributes, setBirthdate, setBirthdateEstimated, setCauseOfDeath, setDead, setDeathDate, setGender, setNames, setPersonChangedBy, setPersonCreator, setPersonDateChanged, setPersonDateCreated, setPersonDateVoided, setPersonVoided, setPersonVoidedBy, setPersonVoidReason

Methods inherited from class java.lang.Object

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

Field Detail

serialVersionUID

public static final long serialVersionUID

See Also:

Constant Field Values

log

protected static final org.apache.commons.logging.Log log

Constructor Detail

Patient

public Patient()

default constructor

Patient

public Patient(Person person)

Patient

public Patient(java.lang.Integer patientId)

Constructor with default patient id

Parameters:

patientId -

Method Detail

equals

public boolean equals(java.lang.Object obj)

Compares two objects for similarity This must pass through to the parent object (org.openmrs.Person) in order to get similarity of person/patient objects

Overrides:

equals in class Person

Parameters:

obj -

Returns:

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

See Also:

Person.equals(java.lang.Object)

hashCode

public int hashCode()

The hashcode for a patient/person is used to index the objects in a tree This must pass through to the parent object (org.openmrs.Person) in order to get similarity of person/patient objects

Overrides:

hashCode in class Person

See Also:

Person.hashCode()

getPatientId

public java.lang.Integer getPatientId()

Returns:

internal identifier for patient

setPatientId

public void setPatientId(java.lang.Integer patientId)

Sets the internal identifier for a patient. This should never be called directly. It exists only for the use of the supporting infrastructure.

Parameters:

patientId -

setPersonId

public void setPersonId(java.lang.Integer personId)

Overrides the parent setPersonId(Integer) so that we can be sure patient id is also set correctly.

Overrides:

setPersonId in class Person

Parameters:

personId - The personId to set.

See Also:

Person.setPersonId(java.lang.Integer)

getTribe

public Tribe getTribe()

Returns:

patient's tribe

setTribe

public void setTribe(Tribe tribe)

Parameters:

tribe - patient's tribe

getIdentifiers

public java.util.Set<PatientIdentifier> getIdentifiers()

Get all of this patients identifiers -- both voided and non-voided ones. If you want only non-voided identifiers, use getActiveIdentifiers()

Returns:

Set of all known identifiers for this patient

See Also:

PatientIdentifier, getActiveIdentifiers()

setIdentifiers

public void setIdentifiers(java.util.Set<PatientIdentifier> identifiers)

Parameters:

patientIdentifiers - update all known identifiers for patient

See Also:

PatientIdentifier

addIdentifiers

public void addIdentifiers(java.util.Collection<PatientIdentifier> patientIdentifiers)

Will only add PatientIdentifiers in this list that this patient does not have already

Parameters:

patientIdentifiers -

addIdentifier

public void addIdentifier(PatientIdentifier patientIdentifier)

Will add this PatientIdentifier if the patient doesn't contain it already

Parameters:

patientIdentifier -

removeIdentifier

public void removeIdentifier(PatientIdentifier patientIdentifier)

getPatientIdentifier

public PatientIdentifier getPatientIdentifier()

Convenience method to get the "preferred" identifier for patient.

Returns:

Returns the "preferred" patient identifier.

getPatientIdentifier

public PatientIdentifier getPatientIdentifier(java.lang.Integer identifierTypeId)

Return's the first (preferred) patient identifier matching identifierTypeId

Parameters:

identifierTypeId -

Returns:

preferred patient identifier

getPatientIdentifier

public PatientIdentifier getPatientIdentifier(java.lang.String identifierTypeName)

Return's the first (preferred) patient identifier matching identifierTypeName

Parameters:

identifierTypeName -

Returns:

preferred patient identifier

getActiveIdentifiers

public java.util.List<PatientIdentifier> getActiveIdentifiers()

Returns only the non-voided identifiers for this patient. If you want all identifiers, use getIdentifiers()

Returns:

list of non-voided identifiers for this patient

See Also:

getIdentifiers()

toString

public java.lang.String toString()

Overrides:

toString in class Person

See Also:

Object.toString()

getChangedBy

public User getChangedBy()

setChangedBy

public void setChangedBy(User changedBy)

getCreator

public User getCreator()

setCreator

public void setCreator(User creator)

getDateChanged

public java.util.Date getDateChanged()

setDateChanged

public void setDateChanged(java.util.Date dateChanged)

getDateCreated

public java.util.Date getDateCreated()

setDateCreated

public void setDateCreated(java.util.Date dateCreated)

getDateVoided

public java.util.Date getDateVoided()

setDateVoided

public void setDateVoided(java.util.Date dateVoided)

getVoided

public java.lang.Boolean getVoided()

isVoided

public java.lang.Boolean isVoided()

setVoided

public void setVoided(java.lang.Boolean voided)

getVoidedBy

public User getVoidedBy()

setVoidedBy

public void setVoidedBy(User voidedBy)

getVoidReason

public java.lang.String getVoidReason()

setVoidReason

public void setVoidReason(java.lang.String voidReason)