org.hl7.rim
Interface ControlAct

All Superinterfaces:

Act, BasicAct, java.lang.Cloneable, Hibernatable, InfrastructureRoot, RimObject

All Known Implementing Classes:

AbstractSessionImpl, ApplicationActDefinitionImpl, ApplicationActImpl, ApplicationExitCommand, ApplicationRuntimeImpl, ChangeActStatusCommand, ChangeAllergyStatusCommand, ChangeMedicationStatusCommand, ChangeProblemStatusCommand, CloseOpenTabsCommand, CommandImpl, ControlActDecorator, ControlActImpl, EditActCommand, EditAllergyCommand, EditAppointmentCommand, EditCommand, EditObservationCommand, EditPatientCommand, EditProblemCommand, EditRimObjectCommand, EditRoleCommand, EditSubstanceAdministrationCommand, EditUserCommand, PatientCloseCommand, PatientSessionImpl, PrintCommand, PrintMedicationListCommand, RenewMedicationListCommand, UserAuthenticateCommand, UserLogOffCommand, UserSessionImpl

public interface ControlAct
extends Act

An act representing a change to the state of another class, a user event (e.g. query), or a system event (e.g. time-based occurrences).

Examples:

• Discharging a patient (Encounter from Active to Completed);

• Stopping a medication (SubstanceAdministration from Active to Aborted);

• Sending an end-of-day summary (time-based event).

Discussion: This class corresponds to the concept of 'Trigger Event', and as such, must be present as the focus of every messaging interaction (because of the 1..1 association between a trigger event and an interaction.) However, control acts can also appear within a message payload. For example, a set of control acts associated with a Lab Order identifying the events that have occurred against that order (first created, then revised, then suspended, then resumed, then completed.)

Method Summary

Message	getPayload()
QueryEvent	getQueryEvent()
void	setPayload(Message payload) Sets the property payload.
void	setQueryEvent(QueryEvent queryEvent) Sets the property queryEvent.

Methods inherited from interface org.hl7.rim.Act

addInboundRelationship, addOutboundRelationship, addParticipation, getActivityTime, getAvailabilityTime, getCode, getConfidentialityCode, getDerivationExpr, getEffectiveTime, getId, getInboundRelationship, getIndependentInd, getInterruptibleInd, getLanguageCode, getLevelCode, getNegationInd, getOutboundRelationship, getParticipation, getPriorityCode, getReasonCode, getRepeatNumber, getStatusCode, getText, getTitle, getUncertaintyCode, setActivityTime, setAvailabilityTime, setCode, setConfidentialityCode, setDerivationExpr, setEffectiveTime, setId, setInboundRelationship, setIndependentInd, setInterruptibleInd, setLanguageCode, setLevelCode, setNegationInd, setOutboundRelationship, setParticipation, setPriorityCode, setReasonCode, setRepeatNumber, setStatusCode, setText, setTitle, setUncertaintyCode

Methods inherited from interface org.hl7.rim.BasicAct

getClassCode, getMoodCode, setClassCode, setMoodCode

Methods inherited from interface org.hl7.rim.InfrastructureRoot

getNullFlavor, getRealmCode, getTemplateId, getTypeId, setNullFlavor, setRealmCode, setTemplateId, setTypeId

Methods inherited from interface org.hl7.rim.RimObject

clone, getCloneCode, getType, setCloneCode, setType

Methods inherited from interface org.hl7.hibernate.Hibernatable

getInternalId, getInternalVersionNumber, setInternalId, setInternalVersionNumber

Method Detail

getPayload

Message getPayload()

setPayload

void setPayload(Message payload)

Sets the property payload.

See Also:

getPayload()

getQueryEvent

QueryEvent getQueryEvent()

setQueryEvent

void setQueryEvent(QueryEvent queryEvent)

Sets the property queryEvent.

See Also:

getQueryEvent()