Package org.openmrs

These classes represent the core domain objects for the OpenMRS project.

See: Description

Interface Summary

Interface	Description
Address	Defines the standard fields for an Address in OpenMRS
Attributable<E>	Classes marked with this interface are able to be special values for a PersonAttribute.
Auditable	In OpenMRS, the convention is to track basic audit information for each object related to who initially created the object and when, and who last changed the object and when.
Changeable	Base interface for domain objects that need to track information related to when they were changed and the user that last changed them.
Creatable	Base interface for domain objects that need to track information related to when they were created and the user that created them.
DosingInstructions	The instructions for different drug prescriptions can vary greatly.
FormRecordable	Defines the methods to make a bridge between an OpenMrsObject and is position in the form.
OpenmrsData	In OpenMRS, we distinguish between data and metadata within our data model.
OpenmrsMetadata	In OpenMRS, we distinguish between data and metadata within our data model.
OpenmrsObject	This is the base interface for all OpenMRS-defined classes
PrivilegeListener	Allows to track down which privileges are checked during code execution and makes it easier for an administrator to assign required privileges to users.
Retireable	In OpenMRS, data are rarely fully deleted (purged) from the system; rather, they are either voided or retired.
UserSessionListener	Allows tracking down both login and logout events including their status Beans implementing this class are picked up by Context.logout() and Context.authenticate(String, String)
Voidable	In OpenMRS, data are rarely fully deleted (purged) from the system; rather, they are either voided or retired.

Class Summary

Class	Description
Allergen	Represent allergen
Allergies	Represents patient allergies
Allergy	Represent allergy
AllergyConstants
AllergyProperties
AllergyReaction	Represent allergy reactions
BaseChangeableOpenmrsData	Base superclass for all mutable OpenmrsData.
BaseChangeableOpenmrsMetadata	Base superclass for all mutable OpenmrsMetadata.
BaseConceptMap	Superclass for ConceptMaps and ConceptReferenceTermMaps
BaseCustomizableData<A extends Attribute>	Extension of BaseOpenmrsData for classes that support customization via user-defined attributes.
BaseCustomizableMetadata<A extends Attribute>	Extension of BaseOpenmrsMetadata for classes that support customization via user-defined attributes.
BaseDosingInstructions
BaseFormRecordableOpenmrsData	Base implementation of FormRecordable that bridges between a saved BaseChangeableOpenmrsData entity and the path in a form where it was recorded.
BaseOpenmrsData	In OpenMRS, we distinguish between data and metadata within our data model.
BaseOpenmrsMetadata	In OpenMRS, we distinguish between data and metadata within our data model.
BaseOpenmrsObject	This is the base implementation of the OpenmrsObject interface.
CareSetting	Care Setting defines the scope of care for any piece of data within the medical record.
CodedOrFreeText	A Concept object can represent either a question or an answer to a data point.
Cohort	This class represents a list of patientIds.
CohortMembership
Concept	A Concept object can represent either a question or an answer to a data point.
ConceptAnswer	This class represents one option for an answer to a question type of Concept.
ConceptAttribute
ConceptAttributeType
ConceptClass	ConceptClass
ConceptComplex	Child class of Concept that has a ComplexObsHandler associated with the Concept.
ConceptDatatype	ConceptDatatype
ConceptDescription	ConceptDescription is the localized description of a concept.
ConceptMap	The concept map object represents a mapping of Concept to ConceptSource.
ConceptMapType	ConceptMapType are used to define relationships between concepts and concept reference terms e.g IS_A or SAME_AS, BROADER_THAN
ConceptName	ConceptName is the real world term used to express a Concept within the idiom of a particular locale.
ConceptNameTag	ConceptNameTag is a textual tag which can be applied to a ConceptName.
ConceptNumeric	The ConceptNumeric extends upon the Concept object by adding some number range values
ConceptProposal	A ConceptProposal is a temporary holder for concept that should be in the system.
ConceptReferenceTerm	A concept reference term is typically name for a concept by which it is referred in another institution like ICD9, ICD10, SNOMED that keeps a concept dictionary or any other OpenMRS implementation
ConceptReferenceTermMap	The concept Reference Term map object represents a mapping between two Concept Reference Terms.
ConceptSearchResult	An Object of this class represents a search result returned when searching for concepts, it holds extra metadata about the matched concept(s).
ConceptSet	This represents a single concept within a concept set.
ConceptSource	A concept source is defined as any institution that keeps a concept dictionary.
ConceptStateConversion	ConceptStateConversion
ConceptStopWord	ConceptStopWord is the real world term used to filter the words for indexing from search phrase.
Condition	The condition class records detailed information about a condition, problem, diagnosis, or other situation or issue.
Diagnosis	Diagnosis class defines the identification of the nature of an illness or other problem by examination of the symptoms during an encounter (visit or interaction of a patient with a healthcare worker).
DiagnosisAttribute	The DiagnosisAttribute, value for the DiagnosisAttributeType that is stored in a Diagnosis.
DiagnosisAttributeType	The DiagnosisAttributeType extension to the Diagnosis class.
Drug	Drug
DrugIngredient	DrugIngredient
DrugOrder	DrugOrder
DrugReferenceMap	The DrugReferenceMap map object represents a mapping between a drug and alternative drug terminologies.
Duration	Duration represented using SNOMED CT duration codes
Encounter	An Encounter represents one visit or interaction of a patient with a healthcare worker.
EncounterProvider	Mapping Class between Encounters and Providers which allows many to many relationship.
EncounterRole	An EncounterRole a role specific to the encounter.
EncounterType	An EncounterType defines how a certain kind of Encounter.
Field	Field
FieldAnswer	FieldAnswer
FieldType	FieldType
Form	Form
FormField	The FormField object relates/orders the fields on a form A form can have many 0 to n fields associated with it in a hierarchical manor.
FormField.DefaultComparator	Provides a default comparator.
FormResource	A FormResource is meant as a way for modules to add arbitrary information to a Form.
FreeTextDosingInstructions
GlobalProperty	Global properties are simple key-value pairs persisted in the database GPs can be thought of as something similar to environment variables used in operating systems.
ImplementationId	Every installation of OpenMRS should get a unique implementation id.
Location	A Location is a physical place, such as a hospital, a room, a clinic, or a district.
LocationAttribute	A value for a user-defined LocationAttributeType that is stored on a Location.
LocationAttributeType	A user-defined extension to the Location class.
LocationTag	An LocationTag allows categorization of Locations
MedicationDispense	The MedicationDispense class records detailed information about the provision of a supply of a medication with the intention that it is subsequently consumed by a patient (usually in response to a prescription).
Obs	An observation is a single unit of clinical information.
ObsPostLoadEventListener	Hibernate by default calls setters when initializing a persistent entity from the database meaning an Obs would be marked dirty the first time it's loaded by hibernate, therefore we need to use an instance of this PostLoadEventListener to mark an Obs as not dirty when it gets loaded.
OpenmrsCharacterEscapes	An instance of this class can be passed to an ObjectMapper instance when serializing objects to JSON using the jackson API so as to escape html and scripts inside html tags
Order	Encapsulates information about the clinical action of a provider requesting something for a patient e.g requesting a test to be performed, prescribing a medication, requesting the patient to enroll on a specific diet etc.
OrderAttribute	The OrderAttribute, value for the OrderAttributeType that is stored in an Order.
OrderAttributeType	The OrderAttributeType, extension to the Order class.
OrderFrequency	The frequency at which an Order's action should be repeated, e.g.
OrderGroup	Contains a group of Orders that are ordered together within a single encounter,often driven by an OrderSet.
OrderGroupAttribute	A value for a user-defined OrderGroupAttributeType that is stored in an OrderGroup.
OrderGroupAttributeType	A user-defined extension to the OrderGroup class.
OrderSet	Represents the grouping of orders into a set, so as to give decision support for the doctors
OrderSetAttribute	A value for a user-defined OrderSetAttributeType that is stored on a OrderSet.
OrderSetAttributeType	A user-defined extension to the OrderSet class.
OrderSetMember
OrderType	OrderTypes are used to classify different types of Orders e.g to distinguish between Serology and Radiology TestOrders
Patient	Defines a Patient in the system.
PatientIdentifier	A Patient can have zero to n identifying PatientIdentifier(s).
PatientIdentifier.DefaultComparator	Provides a default comparator.
PatientIdentifierType	PatientIdentifierType
PatientProgram	PatientProgram
PatientProgramAttribute
PatientState	PatientState
Person	A Person in the system.
PersonAddress	This class is the representation of a person's address.
PersonAttribute	A PersonAttribute is meant as way for implementations to add arbitrary information about a user/patient to their database.
PersonAttribute.DefaultComparator	Provides a default comparator.
PersonAttributeType	PersonAttributeType
PersonAttributeType.DefaultComparator	Provides a default comparator.
PersonName	A Person can have zero to n PersonName(s).
PersonName.DefaultComparator	Provides a default comparator.
Privilege	Privilege
Program	Program
ProgramAttributeType
ProgramWorkflow	ProgramWorkflow
ProgramWorkflowState	ProgramWorkflowState
Provider	Represents a person who may provide care to a patient during an encounter
ProviderAttribute	A value for a user-defined ProviderAttributeType that is stored on a Provider.
ProviderAttributeType	A user-defined extension to the Provider class.
ReferralOrder	This is a type of order that adds referral specific attributes.
Relationship	Relationship
RelationshipType	Defines a type of relationship between two people in the database.
Role	A Role is just an aggregater of Privileges.
ServiceOrder	Provides properties for several order types like TestOrder , ReferralOrder and others depending on the openmrs implementation use case as need arises
SimpleDosingInstructions
TestOrder	This is a type of order that adds tests specific attributes like: laterality, clinical history, etc.
User	Defines a User Account in the system.
Visit	A 'visit' is a contiguous time period where encounters occur between patients and healthcare providers.
VisitAttribute	A value for a user-defined VisitAttributeType that is stored on a Visit.
VisitAttributeType	A user-defined extension to the Visit class.
VisitType	Represents the assortment of visit types available to an implementation.

Enum Summary

Enum	Description
AllergenType
AllergySeverity
CareSetting.CareSettingType
ConditionClinicalStatus	The ConditionClinicalStatus is what we've historically called "condition status" and what FHIR refers to as ConditionClinicalStatus .
ConditionVerificationStatus	The ConditionVerificationStatus is what we've historically called "diagnosis certainty" and what FHIR refers to as ConditionVerificationStatus.
Obs.Interpretation
Obs.Status
Order.Action
Order.FulfillerStatus	Valid values for the status of an order that is received from a filler
Order.Urgency
OrderSet.Operator	Restrictions put on saving an orderSet.
PatientIdentifierType.LocationBehavior	Enumerates the possible ways that location may be applicable for a particular Patient Identifer Type
PatientIdentifierType.UniquenessBehavior	Enumeration for the way to handle uniqueness among identifiers for a given identifier type
ServiceOrder.Laterality
UserSessionListener.Event
UserSessionListener.Status

Package org.openmrs Description

These classes represent the core domain objects for the OpenMRS project.