Serialized Form

  • Package org.openehealth.ipf.commons.audit

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

    • Class org.openehealth.ipf.commons.audit.model.ActiveParticipantType

      class ActiveParticipantType extends Object implements Serializable

      • Serialized Fields

        • alternativeUserID
          String alternativeUserID

          Alternative unique identifier for the user.

          If the participant is a person, then Alternative User ID shall be the identifier used for that person within an enterprise for authentication purposes, for example, a Kerberos Username (user@realm). If the participant is a DICOM application, then Alternative User ID shall be one or more of the AE Titles that participated in the event.

          Multiple AE titles shall be encoded as: 

           AETITLES= aetitle1;aetitle2;…

          When importing or exporting data, e.g., by means of media, the Alternative UserID field is used either to identify people or to identify the media itself. When the Role ID Code is (110154, DCM, "Destination Media") or (110155, DCM, "Source Media"), the Alternative UserID may be any machine readable identifications on the media, such as media serial number, volume label, or DICOMDIR SOP Instance UID.

        • mediaIdentifier
          String mediaIdentifier
          Volume ID, URI, or other identifier for media. Often required if digital media. May be present otherwise.
        • mediaType
          MediaType mediaType
        • networkAccessPointID
          String networkAccessPointID

          An identifier for the network access point of the user device This could be a device id, IP address, or some other identifier associated with a device.

          The NetworkAccessPointTypeCode and NetworkAccessPointID can be ambiguous for systems that have multiple physical network connections. For these multi-homed nodes a single DNS name or IP address shall be selected and used when reporting audit events. DICOM does not require the use of a specific method for selecting the network connection to be used for identification, but it must be the same for all of the audit messages generated for events on that node.

        • networkAccessPointTypeCode
          NetworkAccessPointTypeCode networkAccessPointTypeCode
          An identifier for the type of network access point.
        • roleIDCodes
          List<ActiveParticipantRoleId> roleIDCodes
        • userID
          @NonNull String userID

          Unique identifier for the user actively participating in the event.

          If the participant is a person, then the User ID shall be the identifier used for that person on this particular system, in the form of loginName@domain-name. If the participant is an identifiable process, the UserID selected shall be one of the identifiers used in the internal system logs. For example, the User ID may be the process ID as used within the local operating system in the local system logs. If the participant is a node, then User ID may be the node name assigned by the system administrator. Other participants such as threads, relocatable processes, web service end-points, web server dispatchable threads, etc. will have an appropriate identifier.

          The implementation shall document in the conformance statement the identifiers used, see Section A.6. The purpose of this requirement is to allow matching of the audit log identifiers with internal system logs on the reporting systems.

          When importing or exporting data, e.g., by means of media, the UserID field is used both to identify people and to identify the media itself. When the Role ID Code is EV(110154, DCM, "Destination Media") or EV(110155, DCM, "Source Media"), the UserID may be:

          • a URI (the preferred form) identifying the source or destination
          • an email address of the form "mailto:user@address"
          • a description of the media type (e.g., DVD) together with a description of its identifying label, as a free text field
          • a description of the media type (e.g., paper, film) together with a description of the location of the media creator (i.e., the printer)

          The UserID field for Media needs to be highly flexible given the large variety of media and transports that might be used.

        • userIsRequestor
          boolean userIsRequestor

          Indicator that the user is or is not the requestor, or initiator, for the event being audited.

          Used to identify which of the participants initiated the transaction being audited. If the audit source cannot determine which of the participants is the requestor, then the field shall be present with the value FALSE in all participants. The system shall not identify multiple participants as UserIsRequestor. If there are several known requestors, the reporting system shall pick only one as UserIsRequestor.

        • userName
          String userName
          A human readable identification of the participant. If the participant is a person, the person's name shall be used. If the participant is a process, then the process name shall be used.

    • Class org.openehealth.ipf.commons.audit.model.AuditMessage

      class AuditMessage extends Object implements Serializable

    • Class org.openehealth.ipf.commons.audit.model.AuditSourceIdentificationType

      class AuditSourceIdentificationType extends Object implements Serializable

      • Serialized Fields

        • auditEnterpriseSiteID
          String auditEnterpriseSiteID

          Logical source location within the healthcare enterprise network, e.g., a hospital or other provider location within a multi-entity provider group.

          Serves to further qualify the Audit Source ID, since Audit Source ID is not required to be globally unique.

        • auditSourceID
          @NonNull String auditSourceID
          Identifier of the source that detected the auditable event and created this audit message. Although often the audit source is one of the participants, it could also be an external system that is monitoring the activities of the participants (e.g., an add-on audit-generating device).
        • auditSourceTypeCode
          List<AuditSource> auditSourceTypeCode

    • Class org.openehealth.ipf.commons.audit.model.DicomObjectDescriptionType

      class DicomObjectDescriptionType extends Object implements Serializable

      • Serialized Fields

        • accession
          List<String> accession
          Accession Number(s) associated with this participant object.
        • anonymized
          Boolean anonymized
          A single value of True or False indicating whether or not all patient identifying information was removed from the data
        • encrypted
          Boolean encrypted
          A single value of True or False indicating whether or not the data was encrypted.
        • mpps
          List<String> mpps
          MPPS Instance UID(s) associated with this participant object.
        • sopClasses
          List<DicomObjectDescriptionType.SOPClass> sopClasses

          The UIDs of SOP classes referred to in this participant object.

          Required if ParticipantObjectIDTypeCode is (110180, DCM, "Study Instance UID") and any of the optional fields (AccessionNumber, ContainsMPPS, NumberOfInstances, ContainsSOPInstances,Encrypted,Anonymized) are present in this Participant Object. May be present if ParticipantObjectIDTypeCode is (110180, DCM, "Study Instance UID") even though none of the optional fields are present.

        • studyIDs
          List<String> studyIDs
          Study Instance UIDs

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

      class EventIdentificationType extends Object implements Serializable

      • Serialized Fields

        • eventActionCode
          EventActionCode eventActionCode
        • eventDateTime
          @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.
        • eventID
          @NonNull EventId eventID
        • eventOutcomeDescription
          String eventOutcomeDescription
        • eventOutcomeIndicator
          @NonNull EventOutcomeIndicator eventOutcomeIndicator
        • eventTypeCodes
          List<EventType> eventTypeCodes
        • purposesOfUse
          List<PurposeOfUse> purposesOfUse

    • Class org.openehealth.ipf.commons.audit.model.ParticipantObjectIdentificationType

      class ParticipantObjectIdentificationType extends Object implements Serializable

      • Serialized Fields

        • participantObjectDataLifeCycle
          ParticipantObjectDataLifeCycle participantObjectDataLifeCycle
          Identifier for the data life-cycle stage for the participant object. This can be used to provide an audit trail for data, over time, as it passes through the system.
        • participantObjectDescriptions
          List<DicomObjectDescriptionType> participantObjectDescriptions
        • participantObjectDetails
          List<TypeValuePairType> participantObjectDetails
        • participantObjectID
          @NonNull String participantObjectID
          Identifies a specific instance of the participant object.
        • participantObjectIDTypeCode
          @NonNull ParticipantObjectIdType participantObjectIDTypeCode
          Describes the identifier that is contained in Participant Object ID.
        • participantObjectName
          String participantObjectName
          An instance-specific descriptor of the Participant Object ID audited, such as a person's name.
        • participantObjectQuery
          byte[] participantObjectQuery
          The actual query for a query-type participant object.
        • participantObjectSensitivity
          String participantObjectSensitivity
          Denotes policy-defined sensitivity for the Participant Object ID such as VIP, HIV status, mental health status, or similar topics.
        • participantObjectTypeCode
          ParticipantObjectTypeCode participantObjectTypeCode
          Code for the participant object type being audited. This value is distinct from the user's role or any user relationship to the participant object.
        • participantObjectTypeCodeRole
          ParticipantObjectTypeCodeRole participantObjectTypeCodeRole
          Code representing the functional application role of Participant Object being audited. The ParticipantObjectTypeCodeRole identifies the role that the object played in the event that is being reported. Most events involve multiple participating objects. ParticipantObjectTypeCodeRole identifies which object took which role in the event. It also covers agents, multi-purpose entities, and multi-role entities. For the purpose of the event one primary role is chosen.

    • Class org.openehealth.ipf.commons.audit.model.TypeValuePairType

      class TypeValuePairType extends Object implements Serializable

      • Serialized Fields

        • type
          String type
        • value
          byte[] value

  • Package org.openehealth.ipf.commons.audit.types