OpenMRSEncounterService¶
-
public interface
OpenMRSEncounterService
¶ Interface for handling encounters on the OpenMRS server.
Methods¶
createEncounter¶
-
Encounter
createEncounter
(String configName, Encounter encounter)¶ Creates the given
encounter
on the OpenMRS server. Configuration with the givenconfigName
will be used while performing this action.Parameters: - configName – the name of the configuration
- encounter – the encounter to be created
Returns: the created encounter
createEncounterType¶
-
EncounterType
createEncounterType
(String configName, EncounterType encounterType)¶ Creates the given
encounterType
on the OpenMRS server. Configuration with the givenconfigName
will be used while performing this action.Parameters: - configName – the name of the configuration
- encounterType – the encounter type to be created
Returns: the created encounter type
deleteEncounter¶
deleteEncounterType¶
getEncounterByUuid¶
-
Encounter
getEncounterByUuid
(String configName, String uuid)¶ Returns the encounter with the given
uuid
. Configuration with the givenconfigName
will be used while performing this action.Parameters: - configName – the name of the configuration
- uuid – the UUID of the encounter
Returns: the encounter with the given UUID
getEncounterTypeByUuid¶
-
EncounterType
getEncounterTypeByUuid
(String configName, String uuid)¶ Returns the encounter type with the given
uuid
. Configuration with the givenconfigName
will be used while performing this action.Parameters: - configName – the name of the configuration
- uuid – the UUID of the encounter type
Returns: the encounter type with given UUID
getEncountersByEncounterType¶
-
List<Encounter>
getEncountersByEncounterType
(String configName, String motechId, String encounterType)¶ Returns a list of encounters of the given
encounterType
for a patient with the givenmotechId
. Configuration with the givenconfigName
will be used while performing this action.Parameters: - configName – the name of the configuration
- motechId – the MOTECH ID of the patient
- encounterType – the type of the encounter
Returns: the list of encounters with the given encounter type for a patient with the given MOTECH ID
getLatestEncounterByPatientMotechId¶
-
Encounter
getLatestEncounterByPatientMotechId
(String configName, String motechId, String encounterType)¶ Returns the latest encounter of type
encounterType
for a patient with the givenmotechId
. Configuration with the givenconfigName
will be used while performing this action.Parameters: - configName – the name of the configuration
- motechId – the MOTECH ID of the patient
- encounterType – the type of the encounter
Returns: the latest encounter of the given type for the patient with the given MOTECH ID