support for roles and purposes-of-use in balp oauth

oehf · Feb 1, 2024 · 7220271 · 7220271
1 parent eb06baa
commit 7220271
Show file tree

Hide file tree

Showing 16 changed files with 57 additions and 21 deletions.
diff --git a/...e/fhir/core/src/main/java/org/openehealth/ipf/commons/ihe/fhir/audit/codes/Constants.java b/...e/fhir/core/src/main/java/org/openehealth/ipf/commons/ihe/fhir/audit/codes/Constants.java
@@ -27,6 +27,9 @@ public class Constants {
     public static final String AUDIT_ENTITY_SYSTEM_NAME = "http://terminology.hl7.org/CodeSystem/audit-entity-type";
     public static final String OBJECT_ROLE_SYSTEM_NAME = "http://terminology.hl7.org/CodeSystem/object-role";
     public static final String AUDIT_LIFECYCLE_SYSTEM_NAME = "http://terminology.hl7.org/CodeSystem/dicom-audit-lifecycle";
-    public static final String OUSER_AGENT_TYPE_SYSTEM_NAME = " http://terminology.hl7.org/CodeSystem/v3-ParticipationType";
+    public static final String OUSER_AGENT_TYPE_SYSTEM_NAME = "http://terminology.hl7.org/CodeSystem/v3-ParticipationType";
     public static final String OUSER_AGENT_TYPE_CODE = "IRCP";
+    public static final String OUSER_AGENT_PURPOSE_OF_USE_SYSTEM_NAME = "http://terminology.hl7.org/CodeSystem/v3-ActReason";
+    public static final String OUSER_AGENT_ROLE_SYSTEM_NAME = "http://terminology.hl7.org/CodeSystem/v3-RoleClass";
+
 }
diff --git a/...ir/core/src/main/java/org/openehealth/ipf/commons/ihe/fhir/audit/events/BalpJwtUtils.java b/...ir/core/src/main/java/org/openehealth/ipf/commons/ihe/fhir/audit/events/BalpJwtUtils.java
@@ -30,6 +30,8 @@
 
 import static org.apache.commons.lang3.StringUtils.isNotBlank;
 import static org.openehealth.ipf.commons.ihe.fhir.audit.codes.Constants.DCM_SYSTEM_NAME;
+import static org.openehealth.ipf.commons.ihe.fhir.audit.codes.Constants.OUSER_AGENT_PURPOSE_OF_USE_SYSTEM_NAME;
+import static org.openehealth.ipf.commons.ihe.fhir.audit.codes.Constants.OUSER_AGENT_ROLE_SYSTEM_NAME;
 import static org.openehealth.ipf.commons.ihe.fhir.audit.codes.Constants.OUSER_AGENT_TYPE_SYSTEM_NAME;
 
 public class BalpJwtUtils {
@@ -53,6 +55,16 @@ public static <D extends BaseAuditMessageBuilder<D>> void addJwtParticipant(D de
                 if (isNotBlank(dataSet.getIssuer())) {
                     ap.setAlternativeUserID(dataSet.getIssuer());
                 }
+                if (!dataSet.getIheIuaPurposeOfUse().isEmpty()) {
+                    dataSet.getIheIuaPurposeOfUse().forEach(purpose -> ap.getRoleIDCodes().add(
+                        ActiveParticipantRoleId.of(CodedValueType.of(purpose,
+                            OUSER_AGENT_PURPOSE_OF_USE_SYSTEM_NAME, ""))));
+                }
+                if (!dataSet.getIheIuaSubjectRole().isEmpty()) {
+                    dataSet.getIheIuaSubjectRole().forEach(role -> ap.getRoleIDCodes().add(
+                        ActiveParticipantRoleId.of(CodedValueType.of(role,
+                            OUSER_AGENT_ROLE_SYSTEM_NAME, ""))));
+                }
                 delegate.addActiveParticipant(ap);
                 if (isNotBlank(dataSet.getClientId())) {
                     ActiveParticipantType clientAp = new ActiveParticipantType(

diff --git a/...ehealth/ipf/commons/ihe/fhir/audit/protocol/AbstractFhirRestTLSSenderIntegrationTest.java b/...ehealth/ipf/commons/ihe/fhir/audit/protocol/AbstractFhirRestTLSSenderIntegrationTest.java
@@ -58,7 +58,7 @@ TlsParameters setupDefaultTlsParameter() {
     @AfterEach
     public void tearDown() {
         LOG.info("FhirAuditRepository size: " + FhirAuditRepository.getAuditEvents().size() + ". Cleanup....");
-        FhirAuditRepository.getAuditEvents().clear();
+        FhirAuditRepository.clearAuditEvents();
         LOG.info("FhirAuditRepository size: " + FhirAuditRepository.getAuditEvents().size());
     }
 

diff --git a/...core/src/test/java/org/openehealth/ipf/commons/ihe/fhir/audit/server/FhirAuditServer.java b/...core/src/test/java/org/openehealth/ipf/commons/ihe/fhir/audit/server/FhirAuditServer.java
@@ -59,6 +59,10 @@ public List<AuditEvent> getAuditEvents() {
         return new ArrayList<>(auditEvents.values());
     }
 
+    public void clearAuditEvents() {
+        auditEvents.clear();
+    }
+
     @Read()
     public AuditEvent read(@IdParam IdType theId) {
         AuditEvent auditEvent = auditEvents.get(theId.getIdPart());

diff --git a/...ore/src/test/java/org/openehealth/ipf/commons/ihe/fhir/extension/FhirAuditRepository.java b/...ore/src/test/java/org/openehealth/ipf/commons/ihe/fhir/extension/FhirAuditRepository.java
@@ -132,6 +132,10 @@ public static List<AuditEvent> getAuditEvents() {
         return fhirAuditServer.getAuditEvents();
     }
 
+    public static void clearAuditEvents() {
+        fhirAuditServer.clearAuditEvents();
+    }
+
     private boolean hasStartedUndertow(){
         return extensionContext.getRoot().getStore(GLOBAL).get(STORE_KEY) != null;
     }

diff --git a/...th/ipf/commons/ihe/fhir/support/audit/marshal/AbstractFhirAuditSerializationStrategy.java b/...th/ipf/commons/ihe/fhir/support/audit/marshal/AbstractFhirAuditSerializationStrategy.java
@@ -47,15 +47,9 @@
 import java.util.List;
 import java.util.Optional;
 import java.util.function.Function;
+import java.util.stream.Collectors;
 
-import static org.openehealth.ipf.commons.ihe.fhir.audit.codes.Constants.AUDIT_ENTITY_SYSTEM_NAME;
-import static org.openehealth.ipf.commons.ihe.fhir.audit.codes.Constants.AUDIT_LIFECYCLE_SYSTEM_NAME;
-import static org.openehealth.ipf.commons.ihe.fhir.audit.codes.Constants.DCM_OCLIENT_CODE;
-import static org.openehealth.ipf.commons.ihe.fhir.audit.codes.Constants.DCM_SYSTEM_NAME;
-import static org.openehealth.ipf.commons.ihe.fhir.audit.codes.Constants.OBJECT_ROLE_SYSTEM_NAME;
-import static org.openehealth.ipf.commons.ihe.fhir.audit.codes.Constants.OUSER_AGENT_TYPE_CODE;
-import static org.openehealth.ipf.commons.ihe.fhir.audit.codes.Constants.OUSER_AGENT_TYPE_SYSTEM_NAME;
-import static org.openehealth.ipf.commons.ihe.fhir.audit.codes.Constants.SECURITY_SOURCE_SYSTEM_NAME;
+import static org.openehealth.ipf.commons.ihe.fhir.audit.codes.Constants.*;
 
 /**
  * @author Christian Ohr
@@ -139,7 +133,7 @@ protected AuditEvent.AuditEventSourceComponent auditSourceIdentificationToEventS
     protected AuditEvent.AuditEventAgentComponent activeParticipantToAgent(ActiveParticipantType ap) {
         Optional<String> oUser = getOAuthAttrFromKnownActiveParticipantRoleIdCode(ap.getRoleIDCodes(), OUSER_AGENT_TYPE_SYSTEM_NAME);
         if (oUser.isPresent()) {
-            return new AuditEvent.AuditEventAgentComponent()
+            AuditEvent.AuditEventAgentComponent agent = new AuditEvent.AuditEventAgentComponent()
                 .setType(new CodeableConcept(
                     new Coding(OUSER_AGENT_TYPE_SYSTEM_NAME, OUSER_AGENT_TYPE_CODE, "information recipient")))
                 .addPolicy(oUser.get())
@@ -149,6 +143,15 @@ protected AuditEvent.AuditEventAgentComponent activeParticipantToAgent(ActivePar
                         .setIdentifier(new Identifier().setSystem(ap.getAlternativeUserID()).setValue(ap.getUserID()))
                         .setDisplay(ap.getUserName()))
                 .setRequestor(ap.isUserIsRequestor());
+            getOAuthListAttrFromKnownActiveParticipantRoleIdCode(
+                ap.getRoleIDCodes(), OUSER_AGENT_PURPOSE_OF_USE_SYSTEM_NAME)
+                .forEach(purpose -> agent.getPurposeOfUse().add(
+                    new CodeableConcept().addCoding(new Coding(OUSER_AGENT_PURPOSE_OF_USE_SYSTEM_NAME, purpose, ""))));
+            getOAuthListAttrFromKnownActiveParticipantRoleIdCode(
+                ap.getRoleIDCodes(), OUSER_AGENT_ROLE_SYSTEM_NAME)
+                .forEach(purpose -> agent.getRole().add(
+                    new CodeableConcept().addCoding(new Coding(OUSER_AGENT_ROLE_SYSTEM_NAME, purpose, ""))));
+            return agent;
         }
         Optional<String> oClient = getOAuthAttrFromKnownActiveParticipantRoleIdCode(ap.getRoleIDCodes(), DCM_SYSTEM_NAME);
         if (oClient.isPresent()) {
@@ -177,6 +180,12 @@ private Optional<String> getOAuthAttrFromKnownActiveParticipantRoleIdCode(List<A
             .map(CodedValueType::getCode);
     }
 
+    private List<String> getOAuthListAttrFromKnownActiveParticipantRoleIdCode(List<ActiveParticipantRoleId> roleCodes,
+                                                                                  String knownCodeSystem) {
+        return roleCodes.stream().filter(p -> p.getCodeSystemName().equals(knownCodeSystem))
+            .map(CodedValueType::getCode).collect(Collectors.toList());
+    }
+
     protected AuditEvent.AuditEventAgentNetworkType auditEventNetworkType(NetworkAccessPointTypeCode naptc) {
         try {
             return naptc != null?

diff --git a/...r/r4/mhd/src/main/java/org/openehealth/ipf/commons/ihe/fhir/iti66/Iti66AuditStrategy.java b/...r/r4/mhd/src/main/java/org/openehealth/ipf/commons/ihe/fhir/iti66/Iti66AuditStrategy.java
@@ -22,6 +22,7 @@
 import org.openehealth.ipf.commons.ihe.fhir.audit.FhirQueryAuditStrategy;
 import org.openehealth.ipf.commons.ihe.fhir.audit.codes.FhirEventTypeCode;
 import org.openehealth.ipf.commons.ihe.fhir.audit.codes.FhirParticipantObjectIdTypeCode;
+import org.openehealth.ipf.commons.ihe.fhir.audit.events.BalpQueryInformationBuilder;
 
 
 /**
@@ -37,7 +38,7 @@ public Iti66AuditStrategy(boolean serverSide) {
 
     @Override
     public AuditMessage[] makeAuditMessage(AuditContext auditContext, FhirQueryAuditDataset auditDataset) {
-        return new QueryInformationBuilder<>(auditContext, auditDataset, FhirEventTypeCode.MobileDocumentManifestQuery)
+        return new BalpQueryInformationBuilder(auditContext, auditDataset, FhirEventTypeCode.MobileDocumentManifestQuery)
                 .addPatients(auditDataset.getPatientIds())
                 .setQueryParameters("MobileDocumentManifestQuery",
                         FhirParticipantObjectIdTypeCode.MobileDocumentManifestQuery,

diff --git a/...r/r4/mhd/src/main/java/org/openehealth/ipf/commons/ihe/fhir/iti67/Iti67AuditStrategy.java b/...r/r4/mhd/src/main/java/org/openehealth/ipf/commons/ihe/fhir/iti67/Iti67AuditStrategy.java
@@ -22,6 +22,7 @@
 import org.openehealth.ipf.commons.ihe.fhir.audit.FhirQueryAuditStrategy;
 import org.openehealth.ipf.commons.ihe.fhir.audit.codes.FhirEventTypeCode;
 import org.openehealth.ipf.commons.ihe.fhir.audit.codes.FhirParticipantObjectIdTypeCode;
+import org.openehealth.ipf.commons.ihe.fhir.audit.events.BalpQueryInformationBuilder;
 
 /**
  * @author Christian Ohr
@@ -35,7 +36,7 @@ public Iti67AuditStrategy(boolean serverSide) {
 
     @Override
     public AuditMessage[] makeAuditMessage(AuditContext auditContext, FhirQueryAuditDataset auditDataset) {
-        return new QueryInformationBuilder(auditContext, auditDataset, FhirEventTypeCode.MobileDocumentReferenceQuery)
+        return new BalpQueryInformationBuilder(auditContext, auditDataset, FhirEventTypeCode.MobileDocumentReferenceQuery)
                 .addPatients(auditDataset.getPatientIds())
                 .setQueryParameters("MobileDocumentReferenceQuery",
                         FhirParticipantObjectIdTypeCode.MobileDocumentReferenceQuery,

diff --git a/...hd/src/main/java/org/openehealth/ipf/commons/ihe/fhir/iti68/Iti68ServerAuditStrategy.java b/...hd/src/main/java/org/openehealth/ipf/commons/ihe/fhir/iti68/Iti68ServerAuditStrategy.java
@@ -24,6 +24,7 @@
 import org.openehealth.ipf.commons.ihe.core.atna.AuditStrategySupport;
 import org.openehealth.ipf.commons.ihe.core.atna.event.PHIExportBuilder;
 import org.openehealth.ipf.commons.ihe.fhir.audit.codes.FhirEventTypeCode;
+import org.openehealth.ipf.commons.ihe.fhir.audit.events.BalpPHIExportBuilder;
 
 import java.util.Map;
 
@@ -45,7 +46,7 @@ public Iti68AuditDataset enrichAuditDatasetFromRequest(Iti68AuditDataset auditDa
 
     @Override
     public AuditMessage[] makeAuditMessage(AuditContext auditContext, Iti68AuditDataset auditDataset) {
-        PHIExportBuilder builder = new PHIExportBuilder<>(auditContext, auditDataset,
+        BalpPHIExportBuilder builder = new BalpPHIExportBuilder(auditContext, auditDataset,
                 EventActionCode.Create,
                 FhirEventTypeCode.MobileDocumentRetrieval)
                 .setPatient(auditDataset.getPatientId());

diff --git a/...in/java/org/openehealth/ipf/commons/ihe/fhir/iti68bin/Iti68BinaryServerAuditStrategy.java b/...in/java/org/openehealth/ipf/commons/ihe/fhir/iti68bin/Iti68BinaryServerAuditStrategy.java
@@ -23,6 +23,7 @@
 import org.openehealth.ipf.commons.ihe.core.atna.event.PHIExportBuilder;
 import org.openehealth.ipf.commons.ihe.fhir.audit.FhirAuditDataset;
 import org.openehealth.ipf.commons.ihe.fhir.audit.codes.FhirEventTypeCode;
+import org.openehealth.ipf.commons.ihe.fhir.audit.events.BalpPHIExportBuilder;
 import org.openehealth.ipf.commons.ihe.fhir.iti68.Iti68AuditDataset;
 
 import java.util.Map;
@@ -45,7 +46,7 @@ public FhirAuditDataset enrichAuditDatasetFromRequest(FhirAuditDataset auditData
 
     @Override
     public AuditMessage[] makeAuditMessage(AuditContext auditContext, FhirAuditDataset auditDataset) {
-        PHIExportBuilder builder = new PHIExportBuilder<>(auditContext, auditDataset,
+        BalpPHIExportBuilder builder = new BalpPHIExportBuilder(auditContext, auditDataset,
                 EventActionCode.Create,
                 FhirEventTypeCode.MobileDocumentRetrieval)
                 .setPatient(auditDataset.getPatientId());

diff --git a/...test/java/org/openehealth/ipf/platform/camel/ihe/fhir/iti105/TestIti105WithBalpAudit.java b/...test/java/org/openehealth/ipf/platform/camel/ihe/fhir/iti105/TestIti105WithBalpAudit.java
@@ -70,7 +70,7 @@ public static void startServer(String contextDescriptor) {
 
     @BeforeEach
     public void beforeEach() {
-        FhirAuditRepository.getAuditEvents().clear();
+        FhirAuditRepository.clearAuditEvents();
     }
 
     @Test

diff --git a/...t/java/org/openehealth/ipf/platform/camel/ihe/fhir/iti65/v421/TestIti65WithBalpAudit.java b/...t/java/org/openehealth/ipf/platform/camel/ihe/fhir/iti65/v421/TestIti65WithBalpAudit.java
@@ -45,7 +45,7 @@ public static void setUpClass() {
 
     @BeforeEach
     public void beforeEach() {
-        FhirAuditRepository.getAuditEvents().clear();
+        FhirAuditRepository.clearAuditEvents();
     }
 
     @Test

diff --git a/...t/java/org/openehealth/ipf/platform/camel/ihe/fhir/iti66/v421/TestIti66WithBalpAudit.java b/...t/java/org/openehealth/ipf/platform/camel/ihe/fhir/iti66/v421/TestIti66WithBalpAudit.java
@@ -48,7 +48,7 @@ public static void setUpClass() {
 
     @BeforeEach
     public void beforeEach() {
-        FhirAuditRepository.getAuditEvents().clear();
+        FhirAuditRepository.clearAuditEvents();
     }
 
     @Test

diff --git a/...c/test/java/org/openehealth/ipf/platform/camel/ihe/fhir/iti67/TestIti67WithBalpAudit.java b/...c/test/java/org/openehealth/ipf/platform/camel/ihe/fhir/iti67/TestIti67WithBalpAudit.java
@@ -51,7 +51,7 @@ public static void setUpClass() {
 
     @BeforeEach
     public void beforeEach() {
-        FhirAuditRepository.getAuditEvents().clear();
+        FhirAuditRepository.clearAuditEvents();
     }
 
     @Test

diff --git a/...c/test/java/org/openehealth/ipf/platform/camel/ihe/fhir/iti68/TestIti68WithBalpAudit.java b/...c/test/java/org/openehealth/ipf/platform/camel/ihe/fhir/iti68/TestIti68WithBalpAudit.java
@@ -41,7 +41,7 @@ public static void setUpClass() {
 
     @BeforeEach
     public void beforeEach() {
-        FhirAuditRepository.getAuditEvents().clear();
+        FhirAuditRepository.clearAuditEvents();
     }
 
     @Test

diff --git a/...test/java/org/openehealth/ipf/platform/camel/ihe/fhir/pharm5/TestPharm5WithBalpAudit.java b/...test/java/org/openehealth/ipf/platform/camel/ihe/fhir/pharm5/TestPharm5WithBalpAudit.java
@@ -40,7 +40,7 @@ public static void setUpClass() {
 
     @BeforeEach
     public void beforeEach() {
-        FhirAuditRepository.getAuditEvents().clear();
+        FhirAuditRepository.clearAuditEvents();
     }
 
     @Test