| Package | Description | 
|---|---|
| org.openmrs | These classes represent the core domain objects for the OpenMRS project. | 
| org.openmrs.api | 
The primary OpenMRS API interfaces. | 
| org.openmrs.api.db | 
OpenMRS database layer interfaces. | 
| org.openmrs.api.db.hibernate | Resources for Hibernate ORM. | 
| org.openmrs.api.impl | |
| org.openmrs.logic.result | |
| org.openmrs.obs | |
| org.openmrs.obs.handler | 
| Modifier and Type | Field and Description | 
|---|---|
| protected Obs | Obs. obsGroupThe "parent" of this obs. | 
| Modifier and Type | Field and Description | 
|---|---|
| protected Set<Obs> | Obs. groupMembersThe list of obs grouped under this obs. | 
| Modifier and Type | Method and Description | 
|---|---|
| Obs | ConceptProposal. getObs() | 
| Obs | Obs. getObsGroup()An obs grouping occurs when the question (#getConcept()) is a set. | 
| Obs | Obs. getPreviousVersion()When ObsService updates an obs, it voids the old version, creates a new Obs with the updates,
 and adds a reference to the previousVersion in the new Obs. getPreviousVersion returns the
 last version of this Obs. | 
| static Obs | Obs. newInstance(Obs obsToCopy)This is an equivalent to a copy constructor. | 
| Modifier and Type | Method and Description | 
|---|---|
| Set<Obs> | Encounter. getAllFlattenedObs(boolean includeVoided)Returns all encounter obs as a flatten list(Set) of obs. | 
| Set<Obs> | Encounter. getAllObs()Convenience method to call  Encounter.getAllObs(boolean)with a false parameter | 
| Set<Obs> | Encounter. getAllObs(boolean includeVoided)Returns all Obs where Obs.encounterId = Encounter.encounterId In practice, this method should
 not be used very often... | 
| Set<Obs> | Obs. getGroupMembers()Get the non-voided members of the obs group, if this obs is a group. | 
| Set<Obs> | Obs. getGroupMembers(boolean includeVoided)Get the group members of this obs group, if this obs is a group. | 
| Set<Obs> | Encounter. getObs() | 
| Set<Obs> | Encounter. getObsAtTopLevel(boolean includeVoided)Returns a Set<Obs> of all root-level Obs of an Encounter, including obsGroups | 
| Set<Obs> | Obs. getRelatedObservations()Convenience method that returns related Obs If the Obs argument is not an ObsGroup: a
 Set<Obs> will be returned containing all of the children of this Obs' parent that are
 not ObsGroups themselves. | 
| Modifier and Type | Method and Description | 
|---|---|
| void | Obs. addGroupMember(Obs member)Convenience method to add the given  obsto this grouping. | 
| void | Encounter. addObs(Obs observation)Add the given Obs to the list of obs for this Encounter. | 
| static Obs | Obs. newInstance(Obs obsToCopy)This is an equivalent to a copy constructor. | 
| void | Obs. removeGroupMember(Obs member)Convenience method to remove an Obs from this grouping This also removes the link in the
 given  obsobject to this obs grouper | 
| void | Encounter. removeObs(Obs observation)Remove the given observation from the list of obs for this Encounter | 
| void | ConceptProposal. setObs(Obs obs) | 
| void | Obs. setObsGroup(Obs obsGroup)This method does NOT add this current obs to the list of obs in obsGroup.getGroupMembers(). | 
| void | Obs. setPreviousVersion(Obs previousVersion)A previousVersion indicates that this Obs replaces an earlier one. | 
| Modifier and Type | Method and Description | 
|---|---|
| void | Obs. setGroupMembers(Set<Obs> groupMembers)Set the members of the obs group, if this obs is a group. | 
| void | Encounter. setObs(Set<Obs> obs) | 
| Modifier and Type | Method and Description | 
|---|---|
| Obs | ObsService. getComplexObs(Integer obsId,
             String view)Deprecated. 
 as of 2.1.0, use  ObsService.getObs(Integer) | 
| Obs | ObsService. getObs(Integer obsId)Get an observation | 
| Obs | ObsService. getObsByUuid(String uuid)Get Obs by its UUID | 
| Obs | ObsService. getRevisionObs(Obs initialObs)Get Revision Obs for initial Obs | 
| Obs | ObsService. saveObs(Obs obs,
       String changeMessage)Save the given obs to the database. | 
| Obs | ObsService. unvoidObs(Obs obs)Revive an observation (pull a Lazarus) | 
| Obs | ObsService. voidObs(Obs obs,
       String reason)Equivalent to deleting an observation | 
| Modifier and Type | Method and Description | 
|---|---|
| List<Obs> | ObsService. getObservations(List<Person> whom,
               List<Encounter> encounters,
               List<Concept> questions,
               List<Concept> answers,
               List<OpenmrsConstants.PERSON_TYPE> personTypes,
               List<Location> locations,
               List<String> sort,
               Integer mostRecentN,
               Integer obsGroupId,
               Date fromDate,
               Date toDate,
               boolean includeVoidedObs)This method fetches observations according to the criteria in the given arguments. | 
| List<Obs> | ObsService. getObservations(List<Person> whom,
               List<Encounter> encounters,
               List<Concept> questions,
               List<Concept> answers,
               List<OpenmrsConstants.PERSON_TYPE> personTypes,
               List<Location> locations,
               List<String> sort,
               Integer mostRecentN,
               Integer obsGroupId,
               Date fromDate,
               Date toDate,
               boolean includeVoidedObs,
               String accessionNumber) | 
| List<Obs> | ObsService. getObservations(List<Person> whom,
               List<Encounter> encounters,
               List<Concept> questions,
               List<Concept> answers,
               List<OpenmrsConstants.PERSON_TYPE> personTypes,
               List<Location> locations,
               List<String> sort,
               List<Visit> visits,
               Integer mostRecentN,
               Integer obsGroupId,
               Date fromDate,
               Date toDate,
               boolean includeVoidedObs,
               String accessionNumber) | 
| List<Obs> | ObsService. getObservations(String searchString)This method searches the obs table based on the given  searchString. | 
| List<Obs> | ObsService. getObservationsByPerson(Person who)Get all Observations for the given person, sorted by obsDatetime ascending. | 
| List<Obs> | ObsService. getObservationsByPersonAndConcept(Person who,
                                 Concept question)Get all nonvoided observations for the given patient with the given concept as the question
 concept (conceptId) | 
| Modifier and Type | Method and Description | 
|---|---|
| ComplexObsHandler | ObsService. getHandler(Obs obs)Get the ComplexObsHandler associated with a complex observation
 Returns the ComplexObsHandler. | 
| Obs | ObsService. getRevisionObs(Obs initialObs)Get Revision Obs for initial Obs | 
| void | ObsService. purgeObs(Obs obs)Completely remove an observation from the database. | 
| void | ObsService. purgeObs(Obs obs,
        boolean cascade)Completely remove an observation from the database. | 
| Obs | ObsService. saveObs(Obs obs,
       String changeMessage)Save the given obs to the database. | 
| Obs | ObsService. unvoidObs(Obs obs)Revive an observation (pull a Lazarus) | 
| Obs | ObsService. voidObs(Obs obs,
       String reason)Equivalent to deleting an observation | 
| Modifier and Type | Method and Description | 
|---|---|
| Obs | ObsDAO. getObs(Integer obsId) | 
| Obs | ObsDAO. getObsByUuid(String uuid) | 
| Obs | ObsDAO. getRevisionObs(Obs initialObs) | 
| Obs | ObsDAO. saveObs(Obs obs) | 
| Modifier and Type | Method and Description | 
|---|---|
| List<Obs> | ObsDAO. getObservations(List<Person> whom,
               List<Encounter> encounters,
               List<Concept> questions,
               List<Concept> answers,
               List<OpenmrsConstants.PERSON_TYPE> personTypes,
               List<Location> locations,
               List<String> sort,
               Integer mostRecentN,
               Integer obsGroupId,
               Date fromDate,
               Date toDate,
               boolean includeVoidedObs,
               String accessionNumber) | 
| List<Obs> | ObsDAO. getObservations(List<Person> whom,
               List<Encounter> encounters,
               List<Concept> questions,
               List<Concept> answers,
               List<OpenmrsConstants.PERSON_TYPE> personTypes,
               List<Location> locations,
               List<String> sortList,
               List<Visit> visits,
               Integer mostRecentN,
               Integer obsGroupId,
               Date fromDate,
               Date toDate,
               boolean includeVoidedObs,
               String accessionNumber) | 
| Modifier and Type | Method and Description | 
|---|---|
| void | ObsDAO. deleteObs(Obs obs) | 
| Obs | ObsDAO. getRevisionObs(Obs initialObs) | 
| Obs.Status | ObsDAO. getSavedStatus(Obs obs)Gets the value of status currently saved in the database for the given obs, bypassing any caches. | 
| Obs | ObsDAO. saveObs(Obs obs) | 
| Modifier and Type | Method and Description | 
|---|---|
| Obs | HibernateObsDAO. getObs(Integer obsId) | 
| Obs | HibernateObsDAO. getObsByUuid(String uuid) | 
| Obs | HibernateObsDAO. getRevisionObs(Obs initialObs) | 
| Obs | HibernateObsDAO. saveObs(Obs obs) | 
| Modifier and Type | Method and Description | 
|---|---|
| List<Obs> | HibernateObsDAO. getObservations(List<Person> whom,
               List<Encounter> encounters,
               List<Concept> questions,
               List<Concept> answers,
               List<OpenmrsConstants.PERSON_TYPE> personTypes,
               List<Location> locations,
               List<String> sortList,
               Integer mostRecentN,
               Integer obsGroupId,
               Date fromDate,
               Date toDate,
               boolean includeVoidedObs,
               String accessionNumber) | 
| List<Obs> | HibernateObsDAO. getObservations(List<Person> whom,
               List<Encounter> encounters,
               List<Concept> questions,
               List<Concept> answers,
               List<OpenmrsConstants.PERSON_TYPE> personTypes,
               List<Location> locations,
               List<String> sortList,
               List<Visit> visits,
               Integer mostRecentN,
               Integer obsGroupId,
               Date fromDate,
               Date toDate,
               boolean includeVoidedObs,
               String accessionNumber) | 
| Modifier and Type | Method and Description | 
|---|---|
| void | HibernateObsDAO. deleteObs(Obs obs) | 
| Obs | HibernateObsDAO. getRevisionObs(Obs initialObs) | 
| Obs.Status | HibernateObsDAO. getSavedStatus(Obs obs) | 
| Obs | HibernateObsDAO. saveObs(Obs obs) | 
| Modifier and Type | Method and Description | 
|---|---|
| Obs | ObsServiceImpl. getComplexObs(Integer obsId,
             String view) | 
| Obs | ObsServiceImpl. getObs(Integer obsId) | 
| Obs | ObsServiceImpl. getObsByUuid(String uuid) | 
| Obs | ObsServiceImpl. getRevisionObs(Obs initialObs) | 
| Obs | ObsServiceImpl. saveObs(Obs obs,
       String changeMessage) | 
| Obs | ObsServiceImpl. unvoidObs(Obs obs)Unvoids an Obs
 
 If the Obs argument is an obsGroup, all group members with the same dateVoided will also be
 unvoided. | 
| Obs | ObsServiceImpl. voidObs(Obs obs,
       String reason)Voids an Obs If the Obs argument is an obsGroup, all group members will be voided. | 
| Modifier and Type | Method and Description | 
|---|---|
| List<Obs> | ObsServiceImpl. getObservations(List<Person> whom,
               List<Encounter> encounters,
               List<Concept> questions,
               List<Concept> answers,
               List<OpenmrsConstants.PERSON_TYPE> personTypes,
               List<Location> locations,
               List<String> sort,
               Integer mostRecentN,
               Integer obsGroupId,
               Date fromDate,
               Date toDate,
               boolean includeVoidedObs) | 
| List<Obs> | ObsServiceImpl. getObservations(List<Person> whom,
               List<Encounter> encounters,
               List<Concept> questions,
               List<Concept> answers,
               List<OpenmrsConstants.PERSON_TYPE> personTypes,
               List<Location> locations,
               List<String> sort,
               Integer mostRecentN,
               Integer obsGroupId,
               Date fromDate,
               Date toDate,
               boolean includeVoidedObs,
               String accessionNumber) | 
| List<Obs> | ObsServiceImpl. getObservations(List<Person> whom,
               List<Encounter> encounters,
               List<Concept> questions,
               List<Concept> answers,
               List<OpenmrsConstants.PERSON_TYPE> personTypes,
               List<Location> locations,
               List<String> sort,
               List<Visit> visits,
               Integer mostRecentN,
               Integer obsGroupId,
               Date fromDate,
               Date toDate,
               boolean includeVoidedObs,
               String accessionNumber) | 
| List<Obs> | ObsServiceImpl. getObservations(String searchString)This implementation queries the obs table comparing the given  searchStringwith
 the patient's identifier, encounterId, and obsId | 
| List<Obs> | ObsServiceImpl. getObservationsByPerson(Person who) | 
| List<Obs> | ObsServiceImpl. getObservationsByPersonAndConcept(Person who,
                                 Concept question) | 
| Modifier and Type | Method and Description | 
|---|---|
| ComplexObsHandler | ObsServiceImpl. getHandler(Obs obs) | 
| Obs | ObsServiceImpl. getRevisionObs(Obs initialObs) | 
| protected boolean | ObsServiceImpl. purgeComplexData(Obs obs)Internal method to remove ComplexData when an Obs is purged. | 
| void | ObsServiceImpl. purgeObs(Obs obs) | 
| void | ObsServiceImpl. purgeObs(Obs obs,
        boolean cascade) | 
| Obs | ObsServiceImpl. saveObs(Obs obs,
       String changeMessage) | 
| Obs | ObsServiceImpl. unvoidObs(Obs obs)Unvoids an Obs
 
 If the Obs argument is an obsGroup, all group members with the same dateVoided will also be
 unvoided. | 
| Obs | ObsServiceImpl. voidObs(Obs obs,
       String reason)Voids an Obs If the Obs argument is an obsGroup, all group members will be voided. | 
| Constructor and Description | 
|---|
| Result(Obs obs)Builds a coded result from an observation | 
| Modifier and Type | Method and Description | 
|---|---|
| Obs | ComplexObsHandler. getObs(Obs obs,
      String view)Fetches the ComplexData from the location indicated from Obs.value_complex, attaches
 ComplexData onto the Obs and returns the Obs. | 
| Obs | ComplexObsHandler. saveObs(Obs obs)Save a complex obs. | 
| Modifier and Type | Method and Description | 
|---|---|
| Obs | ComplexObsHandler. getObs(Obs obs,
      String view)Fetches the ComplexData from the location indicated from Obs.value_complex, attaches
 ComplexData onto the Obs and returns the Obs. | 
| boolean | ComplexObsHandler. purgeComplexData(Obs obs)Completely removes the ComplexData Object from its storage location. | 
| Obs | ComplexObsHandler. saveObs(Obs obs)Save a complex obs. | 
| Modifier and Type | Method and Description | 
|---|---|
| Obs | TextHandler. getObs(Obs obs,
      String view) | 
| Obs | MediaHandler. getObs(Obs obs,
      String view)Currently supports all views and puts the media file data into the ComplexData object | 
| Obs | ImageHandler. getObs(Obs obs,
      String view)Currently supports all views and puts the Image file data into the ComplexData object | 
| Obs | BinaryStreamHandler. getObs(Obs obs,
      String view)Returns the same ComplexData for all views. | 
| Obs | BinaryDataHandler. getObs(Obs obs,
      String view)Currently supports the following views: org.openmrs.obs.ComplexObsHandler#RAW_VIEW | 
| Obs | AbstractHandler. getObs(Obs obs,
      String view) | 
| Obs | TextHandler. saveObs(Obs obs) | 
| Obs | MediaHandler. saveObs(Obs obs) | 
| Obs | ImageHandler. saveObs(Obs obs) | 
| Obs | BinaryStreamHandler. saveObs(Obs obs) | 
| Obs | BinaryDataHandler. saveObs(Obs obs)TODO should this support a StringReader too? | 
| Modifier and Type | Method and Description | 
|---|---|
| static File | AbstractHandler. getComplexDataFile(Obs obs)Convenience method to create and return a file for the stored ComplexData.data Object | 
| Obs | TextHandler. getObs(Obs obs,
      String view) | 
| Obs | MediaHandler. getObs(Obs obs,
      String view)Currently supports all views and puts the media file data into the ComplexData object | 
| Obs | ImageHandler. getObs(Obs obs,
      String view)Currently supports all views and puts the Image file data into the ComplexData object | 
| Obs | BinaryStreamHandler. getObs(Obs obs,
      String view)Returns the same ComplexData for all views. | 
| Obs | BinaryDataHandler. getObs(Obs obs,
      String view)Currently supports the following views: org.openmrs.obs.ComplexObsHandler#RAW_VIEW | 
| Obs | AbstractHandler. getObs(Obs obs,
      String view) | 
| File | AbstractHandler. getOutputFileToWrite(Obs obs)Returns a  Filefor the given obs complex data to be written to. | 
| boolean | AbstractHandler. purgeComplexData(Obs obs) | 
| Obs | TextHandler. saveObs(Obs obs) | 
| Obs | MediaHandler. saveObs(Obs obs) | 
| Obs | ImageHandler. saveObs(Obs obs) | 
| Obs | BinaryStreamHandler. saveObs(Obs obs) | 
| Obs | BinaryDataHandler. saveObs(Obs obs)TODO should this support a StringReader too? | 
Copyright © 2024 OpenMRS Inc.. All rights reserved.