Package org.openehealth.ipf.commons.audit.event

Class DicomInstancesTransferredBuilder

java.lang.Object

org.openehealth.ipf.commons.audit.event.BaseAuditMessageBuilder<DicomInstancesTransferredBuilder>

org.openehealth.ipf.commons.audit.event.DicomInstancesTransferredBuilder

All Implemented Interfaces:

AuditMessageBuilder<DicomInstancesTransferredBuilder>, Validateable

public class DicomInstancesTransferredBuilder
extends BaseAuditMessageBuilder<DicomInstancesTransferredBuilder>

Builds an Audit Event representing a DICOM Instances Transferred event as specified in http://dicom.nema.org/medical/dicom/current/output/html/part15.html#sect_A.5.3.7

This message describes the event of the completion of transferring DICOM SOP Instances between two Application Entities. This message may only include information about a single patient.

This message may have been preceded by a BeginTransferringDicomInstancesBuilder message. The Begin Transferring Instances message conveys the intent to store SOP Instances, while the Instances Transferred message records the completion of the transfer. Any disagreement between the two messages might indicate a potential security breach.

Since:

3.5

Author:

Christian Ohr

Constructor Summary

Constructors

Constructor	Description
DicomInstancesTransferredBuilder(EventOutcomeIndicator outcome, String eventOutcomeDescription, EventActionCode eventActionCode, EventType eventType, PurposeOfUse... purposesOfUse)

Method Summary

Modifier and Type	Method	Description
DicomInstancesTransferredBuilder	setPatientParticipantObject(String patientId, String patientName)
DicomInstancesTransferredBuilder	setReceivingProcessParticipant(String userId, String altUserId, String userName, String networkId, boolean userIsRequestor)
DicomInstancesTransferredBuilder	setSendingProcessParticipant(String userId, String altUserId, String userName, String networkId, boolean userIsRequestor)
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 org.openehealth.ipf.commons.audit.event.BaseAuditMessageBuilder

addActiveParticipant, addActiveParticipant, addActiveParticipant, addDestinationActiveParticipant, addParticipantObjectIdentification, addParticipantObjectIdentification, addParticipantObjectIdentification, addPatientParticipantObject, addSourceActiveParticipant, addStudyParticipantObject, getMessage, getNetworkAccessPointCodeFromAddress, setAuditSource, setAuditSource, setAuditSource, setAuditSource, setAuditSourceIdentification, setAuditSourceIdentification, setAuditSourceIdentification, setEventIdentification, setEventIdentification

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.openehealth.ipf.commons.audit.event.AuditMessageBuilder

getMessages, getTypeValuePair, getTypeValuePair, getTypeValuePair, getTypeValuePair, self

Constructor Detail

DicomInstancesTransferredBuilder

public DicomInstancesTransferredBuilder(EventOutcomeIndicator outcome,
                                        String eventOutcomeDescription,
                                        EventActionCode eventActionCode,
                                        EventType eventType,
                                        PurposeOfUse... purposesOfUse)

Method Detail

setSendingProcessParticipant

public DicomInstancesTransferredBuilder setSendingProcessParticipant(String userId,
                                                                     String altUserId,
                                                                     String userName,
                                                                     String networkId,
                                                                     boolean userIsRequestor)

Parameters:

userId - The identity of the process sending the data

altUserId - Alternate UserID

userName - UserName

networkId - Network Access Point ID

userIsRequestor - Whether the destination participant represents the requestor (i.e. pull request)

Returns:

this

setReceivingProcessParticipant

public DicomInstancesTransferredBuilder setReceivingProcessParticipant(String userId,
                                                                       String altUserId,
                                                                       String userName,
                                                                       String networkId,
                                                                       boolean userIsRequestor)

Parameters:

userId - The identity of the process receiving the data

altUserId - Alternate UserID

userName - UserName

networkId - Network Access Point ID

userIsRequestor - Whether the destination participant represents the requestor (i.e. pull request)

Returns:

this

setPatientParticipantObject

public DicomInstancesTransferredBuilder setPatientParticipantObject(String patientId,
                                                                    String patientName)

Parameters:

patientId - patient ID

patientName - patient name

Returns:

this

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

Overrides:

validate in class BaseAuditMessageBuilder<DicomInstancesTransferredBuilder>