Package org.openehealth.ipf.commons.audit.model

Class EventIdentificationType

java.lang.Object

org.openehealth.ipf.commons.audit.model.EventIdentificationType

All Implemented Interfaces:

Serializable, Validateable

public class EventIdentificationType
extends Object
implements Serializable, Validateable

Since:

3.5

Author:

Christian Ohr

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
EventIdentificationType(EventId eventID, Instant eventDateTime, EventOutcomeIndicator eventOutcomeIndicator)

Method Summary

Modifier and Type	Method	Description
protected boolean	canEqual(Object other)
boolean	equals(Object o)
EventActionCode	getEventActionCode()
@NonNull Instant	getEventDateTime()	The EventDateTime is the date and time that the event being reported took place.
@NonNull EventId	getEventID()
String	getEventOutcomeDescription()
@NonNull EventOutcomeIndicator	getEventOutcomeIndicator()
List<EventType>	getEventTypeCode()
List<PurposeOfUse>	getPurposesOfUse()	The Purpose of Use value indicates the expected ultimate use of the data, rather than a likely near term use such as "send to X".
int	hashCode()
void	setEventActionCode(EventActionCode eventActionCode)
void	setEventDateTime(@NonNull Instant eventDateTime)	The EventDateTime is the date and time that the event being reported took place.
void	setEventID(@NonNull EventId eventID)
void	setEventOutcomeDescription(String eventOutcomeDescription)
void	setEventOutcomeIndicator(@NonNull EventOutcomeIndicator eventOutcomeIndicator)
void	validate()	Validates the constructed audit message against the specification, because API does not completely prevent constructing incomplete or inconsistent messages.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

EventIdentificationType

public EventIdentificationType(EventId eventID,
                               Instant eventDateTime,
                               EventOutcomeIndicator eventOutcomeIndicator)

Method Detail

getEventTypeCode

public List<EventType> getEventTypeCode()

Returns:

Identifier for the category of event

getPurposesOfUse

public List<PurposeOfUse> getPurposesOfUse()

The Purpose of Use value indicates the expected ultimate use of the data, rather than a likely near term use such as "send to X". As explained in the IHE Access Control White Paper, there are Access Control decisions that are based on the ultimate use of the data. For example a Patient may have provided a BPPC Consent/Authorization for treatment purposes, but explicitly disallowed any use for research regardless of de-identification methods used.

The Purpose Of Use is also included in the Audit Event message to enable some forms of reporting of Accounting of Disclosures and Breach Notification. One specific PurposeOfUse would be a BreakGlass/Emergency-Mode-Access.

The PurposeOfUse value will come from a Value Set. This Value Set should be derived from the codes found in ISO 14265, or XSPA (Cross-Enterprise Security and Privacy Authorization). Implementations should expect that the Value Set used may be using locally defined values

Returns:

Purposes of Use for this event

validate

public void validate()

Description copied from interface: Validateable

Validates the constructed audit message against the specification, because API does not completely prevent constructing incomplete or inconsistent messages.

Specified by:

validate in interface Validateable

equals

public boolean equals(Object o)

Overrides:

equals in class Object

canEqual

protected boolean canEqual(Object other)

hashCode

public int hashCode()

Overrides:

hashCode in class Object

getEventID

@NonNull
public @NonNull EventId getEventID()

setEventID

public void setEventID(@NonNull
                       @NonNull EventId eventID)

getEventDateTime

@NonNull
public @NonNull Instant getEventDateTime()

The EventDateTime is the date and time that the event being reported took place. Some events have a significant duration. In these cases, a date and time shall be chosen by a method that is consistent and appropriate for the event being reported. The EventDateTime shall include the time zone information. Creators of audit messages may support leap-seconds, but are not required to. Recipients of audit messages shall be able to process messages with leap-second information.

setEventDateTime

public void setEventDateTime(@NonNull
                             @NonNull Instant eventDateTime)

The EventDateTime is the date and time that the event being reported took place. Some events have a significant duration. In these cases, a date and time shall be chosen by a method that is consistent and appropriate for the event being reported. The EventDateTime shall include the time zone information. Creators of audit messages may support leap-seconds, but are not required to. Recipients of audit messages shall be able to process messages with leap-second information.

getEventOutcomeIndicator

@NonNull
public @NonNull EventOutcomeIndicator getEventOutcomeIndicator()

setEventOutcomeIndicator

public void setEventOutcomeIndicator(@NonNull
                                     @NonNull EventOutcomeIndicator eventOutcomeIndicator)

getEventOutcomeDescription

public String getEventOutcomeDescription()

setEventOutcomeDescription

public void setEventOutcomeDescription(String eventOutcomeDescription)

getEventActionCode

public EventActionCode getEventActionCode()

setEventActionCode

public void setEventActionCode(EventActionCode eventActionCode)