org.hl7.rim

Interface ControlAct

public interface ControlAct extends RimObject, Act

Interface for RIM class ControlAct.

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
voidaddPayload(Message value)
Adds an association 'payload' to RIM class Message.
AssociationSet<Message>getPayload()
Gets association 'payload' to RIM classes Message with cardinality (0..*).
QueryEventgetQueryEvent()
Gets association 'queryEvent' to RIM class QueryEvent with cardinality (0..1).
voidsetPayload(AssociationSet<Message> value)
Sets associations 'payload' to RIM classes Message with cardinality (0..*).
voidsetQueryEvent(QueryEvent value)
Sets association 'queryEvent' to RIM class QueryEvent with cardinality (0..1).

Method Detail

addPayload

public void addPayload(Message value)
Adds an association 'payload' to RIM class Message.

Parameters: value the added association value

getPayload

public AssociationSet<Message> getPayload()
Gets association 'payload' to RIM classes Message with cardinality (0..*).

Returns: the references to the linked classes

getQueryEvent

public QueryEvent getQueryEvent()
Gets association 'queryEvent' to RIM class QueryEvent with cardinality (0..1).

Returns: the reference to the linked class

setPayload

public void setPayload(AssociationSet<Message> value)
Sets associations 'payload' to RIM classes Message with cardinality (0..*).

Parameters: value the new association values

setQueryEvent

public void setQueryEvent(QueryEvent value)
Sets association 'queryEvent' to RIM class QueryEvent with cardinality (0..1).

Parameters: value the new association value