FM2-640: added FHIR Flag resource

fhir/pom.xml

@@ -0,0 +1,105 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project xmlns="http://maven.apache.org/POM/4.0.0"
+         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
+	<modelVersion>4.0.0</modelVersion>
+	<parent>
+		<groupId>org.openmrs.module</groupId>
+		<artifactId>patientflags</artifactId>
+		<version>3.0.8-SNAPSHOT</version>
+	</parent>
+
+	<artifactId>patientflags-fhir</artifactId>
+	<packaging>jar</packaging>
+	<name>Patient Flags Module FHIR</name>
+	<description>FHIR project for Patient Flags Module</description>
+
+	<dependencies>
+		<dependency>
+			<groupId>org.openmrs.api</groupId>
+			<artifactId>openmrs-api</artifactId>
+			<type>jar</type>
+		</dependency>
+		<dependency>
+			<groupId>org.openmrs.web</groupId>
+			<artifactId>openmrs-web</artifactId>
+			<type>jar</type>
+		</dependency>
+		<dependency>
+			<groupId>org.openmrs.module</groupId>
+			<artifactId>patientflags-api</artifactId>
+			<version>${project.parent.version}</version>
+		</dependency>
+		<dependency>
+			<groupId>org.openmrs.api</groupId>
+			<artifactId>openmrs-api</artifactId>
+			<type>test-jar</type>
+		</dependency>
+		<dependency>
+			<groupId>org.openmrs.web</groupId>
+			<artifactId>openmrs-web</artifactId>
+			<type>test-jar</type>
+		</dependency>
+		<dependency>
+			<groupId>org.openmrs.test</groupId>
+			<artifactId>openmrs-test</artifactId>
+			<type>pom</type>
+		</dependency>
+
+		<!--  include groovy, but mark as provided since it is included with openmrs-core v1.10+-->
+		<dependency>
+			<groupId>org.codehaus.groovy</groupId>
+			<artifactId>groovy</artifactId>
+			<version>1.7.6</version>
+			<type>jar</type>
+			<scope>provided</scope>
+		</dependency>
+
+		<dependency>
+			<groupId>org.openmrs.module</groupId>
+			<artifactId>fhir2-api</artifactId>
+		</dependency>
+		<dependency>
+			<groupId>org.projectlombok</groupId>
+			<artifactId>lombok</artifactId>
+		</dependency>
+	</dependencies>
+
+	<build>
+		<resources>
+			<resource>
+				<directory>src/main/resources</directory>
+				<filtering>true</filtering>
+			</resource>
+		</resources>
+
+		<testResources>
+			<testResource>
+				<directory>src/test/resources</directory>
+				<filtering>true</filtering>
+				<includes>
+					<include>**/*.xml</include>
+					<include>**/*.txt</include>
+					<include>**/*.properties</include>
+				</includes>
+			</testResource>
+			<testResource>
+				<directory>src/test/resources</directory>
+				<filtering>false</filtering>
+				<excludes>
+					<exclude>**/*.xml</exclude>
+					<exclude>**/*.txt</exclude>
+					<exclude>**/*.properties</exclude>
+				</excludes>
+			</testResource>
+		</testResources>
+	</build>
+
+	<properties>
+		<MODULE_ID>${project.parent.artifactId}</MODULE_ID>
+		<MODULE_NAME>${project.parent.name}</MODULE_NAME>
+		<MODULE_VERSION>${project.parent.version}</MODULE_VERSION>
+		<MODULE_PACKAGE>${project.parent.groupId}.${project.parent.artifactId}</MODULE_PACKAGE>
+	</properties>
+
+</project>

fhir/src/main/java/org/openmrs/patinetflags/FhirFlagService.java

@@ -0,0 +1,12 @@
+package org.openmrs.patinetflags;
+
+import org.hl7.fhir.r4.model.Flag;
+import org.openmrs.module.fhir2.api.FhirService;
+
+import javax.annotation.Nonnull;
+
+public interface FhirFlagService extends FhirService<Flag> {
+
+    @Override
+    Flag get(@Nonnull String uuid);
+}

fhir/src/main/java/org/openmrs/patinetflags/dao/FhirFlagDao.java

@@ -0,0 +1,12 @@
+package org.openmrs.patinetflags.dao;
+
+import org.openmrs.module.fhir2.api.dao.FhirDao;
+import org.openmrs.module.patientflags.PatientFlag;
+
+import javax.annotation.Nonnull;
+
+public interface FhirFlagDao extends FhirDao<PatientFlag> {
+
+    @Override
+    PatientFlag get(@Nonnull String uuid);
+}

fhir/src/main/java/org/openmrs/patinetflags/dao/impl/FhirFlagDaoImpl.java

@@ -0,0 +1,23 @@
+package org.openmrs.patinetflags.dao.impl;
+
+import lombok.Setter;
+import lombok.AccessLevel;
+import org.hibernate.criterion.Restrictions;
+import org.openmrs.Patient;
+import org.openmrs.module.fhir2.api.dao.impl.BaseFhirDao;
+import org.openmrs.module.patientflags.PatientFlag;
+import org.openmrs.patinetflags.dao.FhirFlagDao;
+import org.springframework.stereotype.Component;
+
+import javax.annotation.Nonnull;
+import java.util.List;
+
+@Component
+@Setter(AccessLevel.PACKAGE)
+public class FhirFlagDaoImpl extends BaseFhirDao<PatientFlag> implements FhirFlagDao {
+
+    public List getFlagsByPatientId(@Nonnull Patient patient) {
+            return getSessionFactory().getCurrentSession().createCriteria(PatientFlag.class)
+                    .add(Restrictions.eq("patient", patient)).list();
+    }
+}

fhir/src/main/java/org/openmrs/patinetflags/impl/FhirFlagServiceImpl.java

@@ -0,0 +1,28 @@
+package org.openmrs.patinetflags.impl;
+
+import lombok.AccessLevel;
+import lombok.Getter;
+import lombok.Setter;
+import org.hl7.fhir.r4.model.Flag;
+
+import org.openmrs.module.fhir2.api.impl.BaseFhirService;
+import org.openmrs.module.patientflags.PatientFlag;
+import org.openmrs.patinetflags.FhirFlagService;
+import org.openmrs.patinetflags.dao.FhirFlagDao;
+import org.openmrs.patinetflags.translators.PatientFlagTranslator;
+import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.stereotype.Component;
+import org.springframework.transaction.annotation.Transactional;
+
+@Component
+@Transactional
+@Setter(AccessLevel.PACKAGE)
+@Getter(AccessLevel.PROTECTED)
+public class FhirFlagServiceImpl extends BaseFhirService<Flag, PatientFlag> implements FhirFlagService {
+
+    @Autowired
+    private FhirFlagDao dao;
+
+    @Autowired
+    private PatientFlagTranslator translator;
+}

fhir/src/main/java/org/openmrs/patinetflags/providers/FlagFhirResourceProvider.java

@@ -0,0 +1,42 @@
+package org.openmrs.patinetflags.providers;
+
+import ca.uhn.fhir.rest.annotation.IdParam;
+import ca.uhn.fhir.rest.annotation.Read;
+import ca.uhn.fhir.rest.server.IResourceProvider;
+import ca.uhn.fhir.rest.server.exceptions.ResourceNotFoundException;
+import lombok.Setter;
+import org.hl7.fhir.instance.model.api.IBaseResource;
+import org.hl7.fhir.r4.model.IdType;
+import org.hl7.fhir.r4.model.Flag;
+import org.openmrs.module.fhir2.api.annotations.R4Provider;
+import org.openmrs.patinetflags.FhirFlagService;
+import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.stereotype.Component;
+
+import javax.annotation.Nonnull;
+
+import static lombok.AccessLevel.PACKAGE;
+
+@Component("FlagFhirR4ResourceProvider")
+@R4Provider
+@Setter(PACKAGE)
+public class FlagFhirResourceProvider implements IResourceProvider {
+
+    @Autowired
+    private FhirFlagService flagService;
+
+    @Override
+    public Class<? extends IBaseResource> getResourceType() {
+        return Flag.class;
+    }
+
+    @Read
+    public Flag getFlagById(@IdParam @Nonnull IdType id) {
+        Flag flag = flagService.get(id.getIdPart());
+        if (flag == null) {
+            throw new ResourceNotFoundException("Could not find Flag with Id " + id.getIdPart());
+        }
+        return flag;
+    }
+
+}

fhir/src/main/java/org/openmrs/patinetflags/translators/PatientFlagTranslator.java

@@ -0,0 +1,23 @@
+package org.openmrs.patinetflags.translators;
+
+import org.hl7.fhir.r4.model.Flag;
+import org.openmrs.module.fhir2.api.translators.OpenmrsFhirTranslator;
+import org.openmrs.module.patientflags.PatientFlag;
+
+import javax.annotation.Nonnull;
+
+public interface PatientFlagTranslator extends OpenmrsFhirTranslator<PatientFlag, Flag> {
+    /**
+     * @param patientFlag 
+     * @return
+     */
+    @Override
+    Flag toFhirResource(@Nonnull PatientFlag patientFlag);
+
+    /**
+     * @param flag 
+     * @return
+     */
+    @Override
+    PatientFlag toOpenmrsType(@Nonnull Flag flag);
+}

fhir/src/main/java/org/openmrs/patinetflags/translators/PriorityTranslator.java

@@ -0,0 +1,20 @@
+package org.openmrs.patinetflags.translators;
+
+import org.hl7.fhir.r4.model.CodeableConcept;
+import org.openmrs.module.fhir2.api.translators.ToFhirTranslator;
+import org.openmrs.module.patientflags.Priority;
+
+import javax.annotation.Nonnull;
+
+public interface PriorityTranslator extends ToFhirTranslator<Priority, CodeableConcept> {
+
+    /**
+     * Maps an OpenMRS data element to a FHIR resource
+     *
+     * @param priority the OpenMRS data element to translate
+     * @return the corresponding FHIR resource
+     */
+    @Override
+    CodeableConcept toFhirResource(@Nonnull Priority priority);
+
+}

fhir/src/main/java/org/openmrs/patinetflags/translators/TagTranslator.java

@@ -0,0 +1,20 @@
+package org.openmrs.patinetflags.translators;
+
+import org.hl7.fhir.r4.model.CodeableConcept;
+import org.openmrs.module.fhir2.api.translators.ToFhirTranslator;
+import org.openmrs.module.patientflags.Tag;
+
+import javax.annotation.Nonnull;
+
+public interface TagTranslator extends ToFhirTranslator<Tag, CodeableConcept> {
+
+    /**
+     * Maps an OpenMRS data element to a FHIR resource
+     *
+     * @param tag the OpenMRS data element to translate
+     * @return the corresponding FHIR resource
+     */
+    @Override
+    CodeableConcept toFhirResource(@Nonnull Tag tag);
+
+}

fhir/src/main/java/org/openmrs/patinetflags/translators/impl/PatientFlagTranslatorImpl.java

@@ -0,0 +1,83 @@
+package org.openmrs.patinetflags.translators.impl;
+
+import static org.apache.commons.lang3.Validate.notNull;
+
+import javax.annotation.Nonnull;
+
+import java.util.Collections;
+
+
+import org.hl7.fhir.r4.model.CodeableConcept;
+import org.hl7.fhir.r4.model.Flag;
+import org.hl7.fhir.r4.model.Identifier;
+import org.hl7.fhir.r4.model.Narrative;
+import org.hl7.fhir.r4.model.Period;
+import org.hl7.fhir.utilities.xhtml.XhtmlNode;
+import org.openmrs.module.fhir2.api.translators.PatientReferenceTranslator;
+import org.openmrs.module.patientflags.PatientFlag;
+import org.openmrs.patinetflags.translators.PatientFlagTranslator;
+import org.openmrs.patinetflags.translators.PriorityTranslator;
+import org.openmrs.patinetflags.translators.TagTranslator;
+import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.stereotype.Component;
+
+@Component
+public class PatientFlagTranslatorImpl implements PatientFlagTranslator {
+
+    @Autowired
+    private PatientReferenceTranslator patientReferenceTranslator;
+
+    @Autowired
+    private TagTranslator tagTranslator;
+
+    @Autowired
+    private PriorityTranslator priorityTranslator;
+
+    @Override
+    public Flag toFhirResource(@Nonnull PatientFlag patientFlag) {
+        notNull(patientFlag, "The Openmrs Patient flag object should not be null");
+
+        Flag flag = new Flag();
+
+        flag.setId(patientFlag.getUuid());
+
+        Narrative narrative = new Narrative();
+        narrative.setStatus(Narrative.NarrativeStatus.GENERATED);
+
+        XhtmlNode xhtmlNode = new XhtmlNode();
+        xhtmlNode.setName(patientFlag.getMessage());
+        narrative.setDiv(xhtmlNode);
+        flag.setText(narrative);
+
+
+        Identifier identifier = new Identifier();
+        identifier.setValue(String.valueOf(patientFlag.getPatientFlagId()));
+        flag.setIdentifier(Collections.singletonList(identifier));
+
+        if (patientFlag.getVoided()) {
+            flag.setStatus(Flag.FlagStatus.INACTIVE);
+        } else {
+            flag.setStatus(Flag.FlagStatus.ACTIVE);
+        }
+
+        patientFlag.getFlag().getTags().forEach(tag -> {
+            CodeableConcept codeableConcept = tagTranslator.toFhirResource(tag);
+            flag.addCategory(codeableConcept);
+        });
+
+        flag.setCode(priorityTranslator.toFhirResource(patientFlag.getFlag().getPriority()));
+
+        flag.setSubject(patientReferenceTranslator.toFhirResource(patientFlag.getPatient()));
+
+        Period period = new Period();
+        period.setStart(patientFlag.getDateCreated());
+        flag.setPeriod(period);
+
+        return flag;
+    }
+
+    @Override
+    public PatientFlag toOpenmrsType(@Nonnull Flag flag) {
+        return null;
+    }
+}