dcm4che/dcm4chee-arc-light#37: IHE-ITI-20: Record Audit Event

Author: vrindanayak

dcm4che-audit/src/main/java/org/dcm4che3/audit/AuditMessages.java

@@ -44,6 +44,8 @@
 import java.io.OutputStream;
 import java.io.Reader;
 import java.util.Calendar;
+import java.util.HashSet;
+import java.util.List;
 import java.util.regex.Pattern;
 
 import javax.xml.bind.JAXBContext;
@@ -52,23 +54,10 @@
 import javax.xml.bind.Marshaller;
 import javax.xml.bind.Unmarshaller;
 
-import org.dcm4che3.audit.Accession;
-import org.dcm4che3.audit.ActiveParticipant;
-import org.dcm4che3.audit.AuditMessage;
-import org.dcm4che3.audit.AuditSourceIdentification;
-import org.dcm4che3.audit.EventIdentification;
-import org.dcm4che3.audit.Instance;
-import org.dcm4che3.audit.MPPS;
-import org.dcm4che3.audit.ObjectFactory;
-import org.dcm4che3.audit.ParticipantObjectContainsStudy;
-import org.dcm4che3.audit.ParticipantObjectDescriptionType;
-import org.dcm4che3.audit.ParticipantObjectDetail;
-import org.dcm4che3.audit.ParticipantObjectIdentification;
-import org.dcm4che3.audit.SOPClass;
-
 /**
  * @author Gunter Zeilinger <[email protected]>
  * @author Michael Backhaus <[email protected]>
+ * @author Vrinda Nayak <[email protected]>
  */
 public class AuditMessages {
 
@@ -319,7 +308,7 @@ public void setCodeSystemName(String value) {
     }
 
     public static final class AuditSourceTypeCode
-            extends org.dcm4che3.audit.AuditSourceTypeCode {
+            extends org.dcm4che3.audit.AuditSourceIdentification {
 
         public static final AuditSourceTypeCode EndUserDisplayDevice = 
                 new AuditSourceTypeCode("1");
@@ -550,7 +539,7 @@ public static final class ParticipantObjectIDTypeCode
         public static final ParticipantObjectIDTypeCode MedicalRecordNumber = 
                 new ParticipantObjectIDTypeCode("1");
         public static final ParticipantObjectIDTypeCode PatientNumber =
-                new ParticipantObjectIDTypeCode("2");
+                new ParticipantObjectIDTypeCode("2", "RFC-3881","Patient Number");
         public static final ParticipantObjectIDTypeCode EncounterNumber =
                 new ParticipantObjectIDTypeCode("3");
         public static final ParticipantObjectIDTypeCode EnrolleeNumber =
@@ -564,7 +553,7 @@ public static final class ParticipantObjectIDTypeCode
         public static final ParticipantObjectIDTypeCode ReportName =
                 new ParticipantObjectIDTypeCode("8");    
         public static final ParticipantObjectIDTypeCode ReportNumber =
-                new ParticipantObjectIDTypeCode("9");
+                new ParticipantObjectIDTypeCode("9", "RFC-3881","Report Number");
         public static final ParticipantObjectIDTypeCode SearchCriteria =
                 new ParticipantObjectIDTypeCode("10");
         public static final ParticipantObjectIDTypeCode UserIdentifier =
@@ -577,10 +566,6 @@ public static final class ParticipantObjectIDTypeCode
                 new ParticipantObjectIDTypeCode("110181","DCM","SOP Class UID");
         public static final ParticipantObjectIDTypeCode NodeID = 
                 new ParticipantObjectIDTypeCode("110182","DCM","Node ID");
-        public static final ParticipantObjectIDTypeCode ITI_PatientNumber = 
-                new ParticipantObjectIDTypeCode("2","RFC-3881","Patient Number");
-        public static final ParticipantObjectIDTypeCode ITI_ReportNumber = 
-                new ParticipantObjectIDTypeCode("9","RFC-3881","Report Number");
         public static final ParticipantObjectIDTypeCode ITI_PIXQuery = 
                 new ParticipantObjectIDTypeCode("ITI-9","IHE Transactions","PIX Query");
 
@@ -660,16 +645,16 @@ public static AuditSourceIdentification createAuditSourceIdentification(
         asi.setAuditEnterpriseSiteID(siteID);
         asi.setAuditSourceID(sourceID);
         for (AuditSourceTypeCode type : types)
-            asi.getAuditSourceTypeCode().add(type);
+            asi.getAuditSourceTypeCode().add(type.toString());
         return asi;
    }
 
     public static ParticipantObjectIdentification createParticipantObjectIdentification(
             String id, ParticipantObjectIDTypeCode idType, String name,
             byte[] query, String type, String role, String lifeCycle,
-            String sensitivity, String description,
-            ParticipantObjectDescriptionType descriptionType,
-            ParticipantObjectDetail... details) {
+            String sensitivity, List<String> desc, HashSet<Accession> accessionList, HashSet<MPPS> mppsList,
+            HashSet<SOPClass> sopClasses, Boolean encrypted, Boolean anonymized,
+            ParticipantObjectContainsStudy pocs, ParticipantObjectDetail... details) {
         ParticipantObjectIdentification poi = new ParticipantObjectIdentification();
         poi.setParticipantObjectID(id);
         poi.setParticipantObjectIDTypeCode(idType);
@@ -679,20 +664,25 @@ public static ParticipantObjectIdentification createParticipantObjectIdentificat
         poi.setParticipantObjectTypeCodeRole(role);
         poi.setParticipantObjectDataLifeCycle(lifeCycle);
         poi.setParticipantObjectSensitivity(sensitivity);
-        poi.setParticipantObjectDescription(description);
-        poi.setParticipantObjectDescriptionType(descriptionType);
+        if (null != desc)
+            for (String pod : desc)
+                poi.getParticipantObjectDescription().add(pod);
+        if (null != accessionList)
+            for (Accession acc : accessionList)
+                poi.getAccession().add(acc);
+        if (null != mppsList)
+            for (MPPS mpps : mppsList)
+                poi.getMPPS().add(mpps);
+        if (null != sopClasses)
+            for (SOPClass sopC : sopClasses)
+                poi.getSOPClass().add(sopC);
+        poi.setEncrypted(encrypted);
+        poi.setAnonymized(anonymized);
+        poi.setParticipantObjectContainsStudy(pocs);
         for (ParticipantObjectDetail detail : details)
             poi.getParticipantObjectDetail().add(detail);
         return poi;
     }
-   
-    public static ParticipantObjectDescriptionType createParticipantObjectDescription(
-            Boolean encrypted, Boolean anonymized) {
-        ParticipantObjectDescriptionType podt = new ParticipantObjectDescriptionType();
-        podt.setEncrypted(encrypted);
-        podt.setAnonymized(anonymized);
-        return podt;
-    }
 
     public static ParticipantObjectDetail createParticipantObjectDetail(
             String type, byte[] value) {
@@ -735,6 +725,12 @@ public static Accession createAccession(String accessionNumber) {
         return accession;
     }
 
+    public static StudyIDs createStudyIDs(String studyID) {
+        StudyIDs sID = new StudyIDs();
+        sID.setUID(studyID);
+        return sID;
+    }
+
     public static String alternativeUserIDForAETitle(String... aets) {
         if (aets.length == 0)
             return null;

dcm4che-audit/src/main/rnc/audit-message.rnc

@@ -41,7 +41,7 @@ EventIdentificationType =
 #  Define AuditSourceTypeCode so that an isolated single digit value is acceptable, 
 #    or a token with other csd attributes so that any controlled terminology can also be used.
 AuditSourceIdentificationType =
-  element AuditSourceTypeCode {
+#  element AuditSourceTypeCode {
     attribute code {
       ##  End-user display device, diagnostic display
       "1" |
@@ -60,17 +60,37 @@ AuditSourceIdentificationType =
       ## ISO level 4-6 operating software
       "8" |
       ## External source, other or unknown type
-      "9"
-    } | #  other code values are allowed if a CodeSystem is specified by its name or OID
+      "9"| ## other
+     token }, ## other values are allowed if a codeSystemName is present
+     other-csd-attributes?, ## If these are present, they define the meaning of code
+#    } | #  other code values are allowed if a CodeSystem is specified by its name or OID
 #    CodedValueType
-    attribute csd-code { xsd:string } |
-    attribute displayName { xsd:string }? |
-    attribute originalText { xsd:string } | # declared as required by CP-ITI-731-01 # Note: this corresponds to DICOM "Code Meaning"
-    attribute codeSystem { OID }? |
-    attribute codeSystemName { xsd:string } # declared as required by CP-ITI-731-01
-  }*,
+#    attribute csd-code { xsd:string } |
+#    attribute displayName { xsd:string }? |
+#    attribute originalText { xsd:string } | # declared as required by CP-ITI-731-01 # Note: this corresponds to DICOM "Code Meaning"
+#    attribute codeSystem { OID }? |
+#    attribute codeSystemName { xsd:string } # declared as required by CP-ITI-731-01
+#  }*,
   attribute AuditEnterpriseSiteID { xsd:string }?,
-  attribute AuditSourceID { xsd:string }
+  attribute AuditSourceID { xsd:string },
+  element AuditSourceTypeCode { xsd:string }*
+
+# Define AuditSourceTypeCode so that an isolated single digit value is acceptable, or a token with other csd attributes
+# so that any controlled terminology can also be used.
+#AuditSourceTypeCodeContent =
+#    attribute csd-code {
+#     "1" | ## End-user display device, diagnostic device
+#     "2" | ## Data acquisition device or instrument
+#     "3" | ## Web Server process or thread
+#     "4" | ## Application Server process or thread
+#     "5" | ## Database Server process or thread
+#     "6" | ## Security server, e.g., a domain controller
+#     "7" | ## ISO level 1-3 network component
+#     "8" | ## ISO level 4-6 operating software
+#     "9" | ## other
+#     token }, ## other values are allowed if a codeSystemName is present
+#     other-csd-attributes? ## If these are present, they define the meaning of code
+
 
 ActiveParticipantType =
   element RoleIDCode { CodedValueType }*,
@@ -131,8 +151,8 @@ ParticipantObjectIdentificationType =
   (element ParticipantObjectName { xsd:string }
    | element ParticipantObjectQuery { xsd:base64Binary })?,
   element ParticipantObjectDetail { TypeValuePairType }*,
-  element ParticipantObjectDescription { xsd:string },
-  element ParticipantObjectDescriptionType { ParticipantObjectDescriptionType },
+  element ParticipantObjectDescription { xsd:string }*,
+  ParticipantObjectDescriptionType,
   attribute ParticipantObjectID { xsd:string },
   attribute ParticipantObjectTypeCode {
     ## Person
@@ -253,16 +273,23 @@ ParticipantObjectDescriptionType =
 
 CodedValueType =
   attribute csd-code { xsd:string },
-  CodeSystem,
-  attribute displayName { xsd:string }?,
-  attribute originalText { xsd:string }? # Note: this corresponds to DICOM "Code Meaning"
+  other-csd-attributes
+#  CodeSystem,
+#  attribute displayName { xsd:string }?,
+#  attribute originalText { xsd:string }? # Note: this corresponds to DICOM "Code Meaning"
 
 TypeValuePairType =
   attribute type { xsd:string },
   attribute value { xsd:base64Binary }
 
-CodeSystem =
-  attribute codeSystem { OID }?,
-  attribute codeSystemName { xsd:string }?
+#CodeSystem =
+#  attribute codeSystem { OID }?,
+#  attribute codeSystemName { xsd:string }?
+
+other-csd-attributes =
+  attribute codeSystem { OID }?,       # OID pattern="[0-2]((\.0)|(\.[1-9][0-9]*))*"
+  attribute codeSystemName { xsd:string }?,        # This makes clear that codeSystemName is either an OID or String
+  attribute displayName { xsd:string }?,
+  attribute originalText { xsd:string }? # Note: this corresponds to DICOM "Code Meaning"
 
 OID = xsd:string { pattern = "[0-2]((\.0)|(\.[1-9][0-9]*))*" }

dcm4che-audit/src/main/xjb/bindings.xml

@@ -21,8 +21,8 @@
     <bindings node="//xs:complexType[@name='ParticipantObjectIdentificationType']">
       <class name="ParticipantObjectIdentification" />
     </bindings>
-    <bindings node="//xs:complexType[@name='ParticipantObjectDescriptionType']">
-      <class name="ParticipantObjectDescriptionType" />
-    </bindings>
+    <!--<bindings node="//xs:complexType[@name='ParticipantObjectDescriptionType']">-->
+      <!--<class name="ParticipantObjectDescriptionType" />-->
+    <!--</bindings>-->
   </bindings>
 </bindings>