org.openmrs

Class Patient

java.lang.Object

org.openmrs.BaseOpenmrsObject

org.openmrs.BaseOpenmrsData

org.openmrs.Person

org.openmrs.Patient

All Implemented Interfaces:

Serializable, Auditable, OpenmrsData, OpenmrsObject, Voidable

public class Patient
extends Person
implements 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

Fields

Modifier and Type	Field and Description
static long	serialVersionUID

Fields inherited from class org.openmrs.Person

personId

Fields inherited from class org.openmrs.BaseOpenmrsData

creator

Constructor Summary

Constructors

Constructor and Description
Patient() default constructor
Patient(Integer patientId) Constructor with default patient id
Patient(Person person) This constructor creates a new Patient object from the given Person object.

Method Summary

Modifier and Type	Method and Description
void	addIdentifier(PatientIdentifier patientIdentifier) Will add this PatientIdentifier if the patient doesn't contain it already
void	addIdentifiers(Collection<PatientIdentifier> patientIdentifiers) Will only add PatientIdentifiers in this list that this patient does not have already
boolean	equals(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
List<PatientIdentifier>	getActiveIdentifiers() Returns only the non-voided identifiers for this patient.
Integer	getId()
Set<PatientIdentifier>	getIdentifiers() Get all of this patients identifiers -- both voided and non-voided ones.
Integer	getPatientId()
PatientIdentifier	getPatientIdentifier() Convenience method to get the first "preferred" identifier for a patient.
PatientIdentifier	getPatientIdentifier(Integer identifierTypeId) Return's the first (preferred) patient identifier matching identifierTypeId
PatientIdentifier	getPatientIdentifier(PatientIdentifierType pit) Returns the first (preferred) patient identifier matching a PatientIdentifierType Otherwise, returns the first non-voided identifier Otherwise, null
PatientIdentifier	getPatientIdentifier(String identifierTypeName) Return's the (preferred) patient identifier matching identifierTypeName Otherwise returns that last PatientIdenitifer
List<PatientIdentifier>	getPatientIdentifiers(PatientIdentifierType pit) Returns only the non-voided identifiers for this patient.
Tribe	getTribe() Deprecated. Tribe is not long a value on Patient. Install the Tribe module
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
void	removeIdentifier(PatientIdentifier patientIdentifier) Convenience method to remove the given identifier from this patient's list of identifiers.
void	setId(Integer id)
void	setIdentifiers(Set<PatientIdentifier> identifiers) Update all identifiers for patient
void	setPatientId(Integer patientId) Sets the internal identifier for a patient.
void	setPersonId(Integer personId) Overrides the parent setPersonId(Integer) so that we can be sure patient id is also set correctly.
void	setTribe(Tribe tribe) Deprecated. Tribe is not long a value on Patient. Install the Tribe module
String	toString()

Methods inherited from class org.openmrs.Person

addAddress, addAttribute, addName, getActiveAttributes, getAddresses, getAge, getAge, getAttribute, getAttribute, getAttribute, getAttributeMap, getAttributes, 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, setBirthdateFromAge, setCauseOfDeath, setDead, setDeathDate, setGender, setNames, setPersonChangedBy, setPersonCreator, setPersonDateChanged, setPersonDateCreated, setPersonDateVoided, setPersonVoided, setPersonVoidedBy, setPersonVoidReason

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

getUuid, setUuid

Methods inherited from class java.lang.Object

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

Patient

public Patient()

default constructor

Patient

public Patient(Person person)

This constructor creates a new Patient object from the given Person object. All attributes are copied over to the new object. NOTE! All child collection objects are copied as pointers, each individual element is not copied.

TODO Should the patient specific attributes be copied? (like identifiers)

Parameters:

person - the person object to copy onto a new Patient

See Also:

Person(Person)

Patient

public Patient(Integer patientId)

Constructor with default patient id

Parameters:

patientId -

Method Detail

equals

public boolean equals(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 Integer getPatientId()

Returns:

internal identifier for patient

setPatientId

public void setPatientId(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(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

@Deprecated
public Tribe getTribe()

Deprecated. Tribe is not long a value on Patient. Install the Tribe module

Returns:

patient's tribe

setTribe

@Deprecated
public void setTribe(Tribe tribe)

Deprecated. Tribe is not long a value on Patient. Install the Tribe module

Parameters:

tribe - patient's tribe

getIdentifiers

public 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()

Should:

not return null

setIdentifiers

public void setIdentifiers(Set<PatientIdentifier> identifiers)

Update all identifiers for patient

Parameters:

identifiers - Set to set as update all known identifiers for patient

See Also:

PatientIdentifier

addIdentifiers

public void addIdentifiers(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 -

Should:

not fail with null identifiers list, add identifier to current list, not add identifier that is in list already

removeIdentifier

public void removeIdentifier(PatientIdentifier patientIdentifier)

Convenience method to remove the given identifier from this patient's list of identifiers. If patientIdentifier is null, nothing is done.

Parameters:

patientIdentifier - the identifier to remove

Should:

remove identifier if exists

getPatientIdentifier

public PatientIdentifier getPatientIdentifier()

Convenience method to get the first "preferred" identifier for a patient. Otherwise, returns the first non-voided identifier Otherwise, null

Returns:

Returns the "preferred" patient identifier.

getPatientIdentifier

public PatientIdentifier getPatientIdentifier(PatientIdentifierType pit)

Returns the first (preferred) patient identifier matching a PatientIdentifierType Otherwise, returns the first non-voided identifier Otherwise, null

Parameters:

pit - The PatientIdentifierType of which to return the PatientIdentifier

Returns:

Returns a PatientIdentifier of the specified type.

getPatientIdentifier

public PatientIdentifier getPatientIdentifier(Integer identifierTypeId)

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

Parameters:

identifierTypeId -

Returns:

preferred patient identifier

getPatientIdentifier

public PatientIdentifier getPatientIdentifier(String identifierTypeName)

Return's the (preferred) patient identifier matching identifierTypeName Otherwise returns that last PatientIdenitifer

Parameters:

identifierTypeName -

Returns:

preferred patient identifier

getActiveIdentifiers

public 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()

getPatientIdentifiers

public List<PatientIdentifier> getPatientIdentifiers(PatientIdentifierType pit)

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

Parameters:

pit - PatientIdentifierType

Returns:

list of non-voided identifiers for this patient

See Also:

getIdentifiers()

toString

public String toString()

Overrides:

toString in class Person

See Also:

Object.toString()

getId

public Integer getId()

Specified by:

getId in interface OpenmrsObject

Overrides:

getId in class Person

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

Overrides:

setId in class Person

Parameters:

id - - The unique Identifier for the object

Since:

1.5

See Also:

OpenmrsObject.setId(java.lang.Integer)