web stats
Skip to end of metadata
Go to start of metadata

What is an agent?

An Agent is a MirthResults specific component that has the ability to parse incoming messages and place the associated subject into a subject group. For example we could create a "Diabetes Agent" which would parse a message for specific diabetes like symptoms. When a message matches the agent's criteria the agent would place the subject into a diabetes subject group.

The Agent Plugin Interface

The Agent Plugin interface is an java interface which must be implemented by any Agent Plugin. This interface dictates what is required by any Agent Plugin project.

The Agent Payload

The Agent Payload is a payload of data that is collected at the end of the agent process. This class can be extended to include more information that included by default.

Note: the data is serialized and saved into the database

The Subject Group

A Subject Group is an entity in MirthResults that allows for grouping of subjects. Upon initialization an Agent create's a subject group if necessary.

The Subject Group Member

A Subject Group Member is an entity in MirthResults that allows a Subject to be associated with a Subject Group. You can think of it as a Subject's group membership card. This entity stores the Agent Payload which was mentioned above.

The Cohort Model

The Cohort Model is a java object which describes a subject group. When an agent starts up it uses the data from the cohort model to generate a subject group if needed

note: perhaps change the name of this object to SubjectGroupModel.

Labels: