FHIR Create R4 Questionnaire API

api/src/main/java/org/openmrs/module/fhir2/FhirConstants.java

@@ -356,4 +356,9 @@ private FhirConstants() {
 	public static final String EXACT_TOTAL_SEARCH_PARAMETER = "_exactTotal";
 
 	public static final String COUNT_QUERY_CACHE = "countQueryCache";
+
+	public static final String QUESTIONNAIRE = "Questionnaire";
+
+	public static final String FHIR_QUESTIONNAIRE_TYPE = "FHIR Questionnaire";
+
 }

api/src/main/java/org/openmrs/module/fhir2/api/FhirQuestionnaireService.java

@@ -0,0 +1,33 @@
+/*
+ * This Source Code Form is subject to the terms of the Mozilla Public License,
+ * v. 2.0. If a copy of the MPL was not distributed with this file, You can
+ * obtain one at http://mozilla.org/MPL/2.0/. OpenMRS is also distributed under
+ * the terms of the Healthcare Disclaimer located at http://openmrs.org/license.
+ *
+ * Copyright (C) OpenMRS Inc. OpenMRS is a registered trademark and the OpenMRS
+ * graphic logo is a trademark of OpenMRS Inc.
+ */
+package org.openmrs.module.fhir2.api;
+
+import javax.annotation.Nonnull;
+
+import java.util.Collection;
+import java.util.List;
+
+import ca.uhn.fhir.rest.api.server.IBundleProvider;
+import ca.uhn.fhir.rest.param.TokenParam;
+import org.hl7.fhir.r4.model.Questionnaire;
+import org.openmrs.module.fhir2.api.search.param.QuestionnaireSearchParams;
+
+public interface FhirQuestionnaireService extends FhirService<Questionnaire> {
+
+	List<Questionnaire> getQuestionnairesByIds(@Nonnull Collection<Integer> ids);
+
+	Questionnaire getById(@Nonnull Integer id);
+
+	IBundleProvider searchForQuestionnaires(QuestionnaireSearchParams questionnaireSearchParams);
+
+	IBundleProvider getQuestionnaireEverything(TokenParam identifier);
+
+	IBundleProvider getQuestionnaireEverything();
+}

api/src/main/java/org/openmrs/module/fhir2/api/dao/FhirQuestionnaireDao.java

@@ -0,0 +1,37 @@
+/*
+ * This Source Code Form is subject to the terms of the Mozilla Public License,
+ * v. 2.0. If a copy of the MPL was not distributed with this file, You can
+ * obtain one at http://mozilla.org/MPL/2.0/. OpenMRS is also distributed under
+ * the terms of the Healthcare Disclaimer located at http://openmrs.org/license.
+ *
+ * Copyright (C) OpenMRS Inc. OpenMRS is a registered trademark and the OpenMRS
+ * graphic logo is a trademark of OpenMRS Inc.
+ */
+package org.openmrs.module.fhir2.api.dao;
+
+import javax.annotation.Nonnull;
+
+import java.util.Collection;
+import java.util.List;
+
+import org.openmrs.Form;
+import org.openmrs.annotation.Authorized;
+import org.openmrs.module.fhir2.api.search.param.SearchParameterMap;
+import org.openmrs.util.PrivilegeConstants;
+
+public interface FhirQuestionnaireDao extends FhirDao<Form> {
+
+	@Authorized(PrivilegeConstants.GET_FORMS)
+	Form getQuestionnaireById(@Nonnull Integer id);
+
+	@Authorized(PrivilegeConstants.GET_FORMS)
+	List<Form> getQuestionnairesByIds(@Nonnull Collection<Integer> ids);
+
+	@Override
+	@Authorized(PrivilegeConstants.GET_FORMS)
+	Form get(@Nonnull String uuid);
+
+	@Override
+	@Authorized(PrivilegeConstants.GET_FORMS)
+	List<Form> getSearchResults(@Nonnull SearchParameterMap theParams);
+}

api/src/main/java/org/openmrs/module/fhir2/api/dao/impl/FhirQuestionnaireDaoImpl.java

@@ -0,0 +1,113 @@
+/*
+ * This Source Code Form is subject to the terms of the Mozilla Public License,
+ * v. 2.0. If a copy of the MPL was not distributed with this file, You can
+ * obtain one at http://mozilla.org/MPL/2.0/. OpenMRS is also distributed under
+ * the terms of the Healthcare Disclaimer located at http://openmrs.org/license.
+ *
+ * Copyright (C) OpenMRS Inc. OpenMRS is a registered trademark and the OpenMRS
+ * graphic logo is a trademark of OpenMRS Inc.
+ */
+package org.openmrs.module.fhir2.api.dao.impl;
+
+import static org.hibernate.criterion.Restrictions.*;
+
+import javax.annotation.Nonnull;
+import javax.persistence.criteria.*;
+import javax.persistence.criteria.CriteriaBuilder;
+
+import java.util.ArrayList;
+import java.util.Collection;
+import java.util.List;
+import java.util.stream.Collectors;
+
+import ca.uhn.fhir.rest.param.StringAndListParam;
+import lombok.AccessLevel;
+import lombok.Getter;
+import lombok.Setter;
+import org.hibernate.Session;
+import org.hibernate.SessionFactory;
+import org.openmrs.Form;
+import org.openmrs.FormResource;
+import org.openmrs.module.fhir2.FhirConstants;
+import org.openmrs.module.fhir2.api.dao.FhirQuestionnaireDao;
+import org.openmrs.module.fhir2.api.search.param.SearchParameterMap;
+import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.beans.factory.annotation.Qualifier;
+import org.springframework.stereotype.Component;
+
+@Component
+@Setter(AccessLevel.PACKAGE)
+public class FhirQuestionnaireDaoImpl extends BaseFhirDao<Form> implements FhirQuestionnaireDao {
+
+	@Autowired
+	@Getter(AccessLevel.PUBLIC)
+	@Setter(AccessLevel.PUBLIC)
+	@Qualifier("sessionFactory")
+	private SessionFactory sessionFactory;
+
+	@Override
+	public Form getQuestionnaireById(@Nonnull Integer id) {
+		return (Form) getSessionFactory().getCurrentSession().createCriteria(Form.class).add(eq("formId", id))
+		        .uniqueResult();
+	}
+
+	@Override
+	@SuppressWarnings("unchecked")
+	public List<Form> getQuestionnairesByIds(@Nonnull Collection<Integer> ids) {
+		return getSessionFactory().getCurrentSession().createCriteria(Form.class).add(in("id", ids)).list();
+	}
+
+	@SuppressWarnings("unchecked")
+	@Override
+	public List<Form> getSearchResults(@Nonnull SearchParameterMap theParams) {
+		Session session = sessionFactory.getCurrentSession();
+
+		// Create CriteriaBuilder
+		CriteriaBuilder builder = session.getCriteriaBuilder();
+
+		// Create CriteriaQuery for main query
+		CriteriaQuery<Form> query = builder.createQuery(Form.class);
+		Root<Form> formRoot = query.from(Form.class);
+		formRoot.alias("f");
+
+		// Create Subquery for FormResource
+		Subquery<Long> subquery = query.subquery(Long.class);
+		Root<FormResource> resourceRoot = subquery.from(FormResource.class);
+		resourceRoot.alias("fr");
+		subquery.select(resourceRoot.get("formResourceId")); // Selecting formId to match in main query
+
+		// Add predicates to the subquery
+		List<Predicate> subqueryPredicates = new ArrayList<>();
+		subqueryPredicates.add(builder.equal(resourceRoot.get("form").get("formId"), formRoot.get("formId")));
+		subqueryPredicates.add(builder.equal(resourceRoot.get("name"), FhirConstants.FHIR_QUESTIONNAIRE_TYPE));
+		subquery.where(builder.and(subqueryPredicates.toArray(new Predicate[0])));
+
+		// Main query predicates
+		List<Predicate> mainPredicates = new ArrayList<>();
+		setupSearchParams(mainPredicates, builder, formRoot, theParams);
+		mainPredicates.add(builder.equal(formRoot.get("retired"), false));
+		mainPredicates.add(builder.exists(subquery));
+
+		// Add predicates to the query
+		query.select(formRoot).where(builder.and(mainPredicates.toArray(new Predicate[0])));
+
+		List<Form> results = session.createQuery(query).getResultList();
+		return results.stream().map(this::deproxyResult).collect(Collectors.toList());
+	}
+
+	protected void setupSearchParams(List<Predicate> predicates, CriteriaBuilder builder, Root<Form> root,
+	        SearchParameterMap theParams) {
+		theParams.getParameters().forEach(entry -> {
+			switch (entry.getKey()) {
+				case FhirConstants.NAME_SEARCH_HANDLER:
+					entry.getValue().forEach(param -> {
+						((StringAndListParam) param.getParam()).getValuesAsQueryTokens().stream()
+						        .forEach(l -> l.getValuesAsQueryTokens().stream().forEach(v -> {
+							        predicates.add(builder.equal(root.get("name"), v.getValue()));
+						        }));
+					});
+					break;
+			}
+		});
+	}
+}

api/src/main/java/org/openmrs/module/fhir2/api/impl/FhirQuestionnaireServiceImpl.java

@@ -0,0 +1,96 @@
+/*
+ * This Source Code Form is subject to the terms of the Mozilla Public License,
+ * v. 2.0. If a copy of the MPL was not distributed with this file, You can
+ * obtain one at http://mozilla.org/MPL/2.0/. OpenMRS is also distributed under
+ * the terms of the Healthcare Disclaimer located at http://openmrs.org/license.
+ *
+ * Copyright (C) OpenMRS Inc. OpenMRS is a registered trademark and the OpenMRS
+ * graphic logo is a trademark of OpenMRS Inc.
+ */
+package org.openmrs.module.fhir2.api.impl;
+
+import javax.annotation.Nonnull;
+
+import java.util.Collection;
+import java.util.List;
+import java.util.stream.Collectors;
+
+import ca.uhn.fhir.rest.api.server.IBundleProvider;
+import ca.uhn.fhir.rest.param.TokenAndListParam;
+import ca.uhn.fhir.rest.param.TokenParam;
+import lombok.AccessLevel;
+import lombok.Getter;
+import lombok.Setter;
+import org.hl7.fhir.r4.model.Questionnaire;
+import org.openmrs.Form;
+import org.openmrs.module.fhir2.FhirConstants;
+import org.openmrs.module.fhir2.api.FhirQuestionnaireService;
+import org.openmrs.module.fhir2.api.dao.FhirQuestionnaireDao;
+import org.openmrs.module.fhir2.api.search.SearchQuery;
+import org.openmrs.module.fhir2.api.search.SearchQueryInclude;
+import org.openmrs.module.fhir2.api.search.param.QuestionnaireSearchParams;
+import org.openmrs.module.fhir2.api.search.param.SearchParameterMap;
+import org.openmrs.module.fhir2.api.translators.QuestionnaireTranslator;
+import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.stereotype.Component;
+import org.springframework.transaction.annotation.Transactional;
+
+@Component
+@Transactional
+@Getter(AccessLevel.PROTECTED)
+@Setter(AccessLevel.PACKAGE)
+public class FhirQuestionnaireServiceImpl extends BaseFhirService<Questionnaire, Form> implements FhirQuestionnaireService {
+
+	@Autowired
+	private FhirQuestionnaireDao dao;
+
+	@Autowired
+	private QuestionnaireTranslator translator;
+
+	@Autowired
+	private SearchQueryInclude<Questionnaire> searchQueryInclude;
+
+	@Autowired
+	private SearchQuery<Form, Questionnaire, FhirQuestionnaireDao, QuestionnaireTranslator, SearchQueryInclude<Questionnaire>> searchQuery;
+
+	@Override
+	public List<Questionnaire> getQuestionnairesByIds(@Nonnull Collection<Integer> ids) {
+		List<org.openmrs.Form> questionnaires = dao.getQuestionnairesByIds(ids);
+		return questionnaires.stream().map(translator::toFhirResource).collect(Collectors.toList());
+	}
+
+	@Override
+	public Questionnaire getById(@Nonnull Integer id) {
+		return translator.toFhirResource(dao.getQuestionnaireById(id));
+	}
+
+	@Override
+	@Transactional(readOnly = true)
+	public IBundleProvider searchForQuestionnaires(QuestionnaireSearchParams questionnaireSearchParams) {
+		return searchQuery.getQueryResults(questionnaireSearchParams.toSearchParameterMap(), dao, translator,
+		    searchQueryInclude);
+	}
+
+	@Override
+	@Transactional(readOnly = true)
+	public IBundleProvider getQuestionnaireEverything(TokenParam questionnairId) {
+		SearchParameterMap theParams = new SearchParameterMap().addParameter(FhirConstants.EVERYTHING_SEARCH_HANDLER, "")
+		        .addParameter(FhirConstants.COMMON_SEARCH_HANDLER, FhirConstants.ID_PROPERTY,
+		            new TokenAndListParam().addAnd(questionnairId));
+
+		populateEverythingOperationParams(theParams);
+		return searchQuery.getQueryResults(theParams, dao, translator, searchQueryInclude);
+	}
+
+	@Override
+	public IBundleProvider getQuestionnaireEverything() {
+		SearchParameterMap theParams = new SearchParameterMap().addParameter(FhirConstants.EVERYTHING_SEARCH_HANDLER, "");
+
+		populateEverythingOperationParams(theParams);
+		return searchQuery.getQueryResults(theParams, dao, translator, searchQueryInclude);
+	}
+
+	private void populateEverythingOperationParams(SearchParameterMap theParams) {
+		// Do nothing
+	}
+}

api/src/main/java/org/openmrs/module/fhir2/api/search/param/QuestionnaireSearchParams.java

@@ -0,0 +1,44 @@
+/*
+ * This Source Code Form is subject to the terms of the Mozilla Public License,
+ * v. 2.0. If a copy of the MPL was not distributed with this file, You can
+ * obtain one at http://mozilla.org/MPL/2.0/. OpenMRS is also distributed under
+ * the terms of the Healthcare Disclaimer located at http://openmrs.org/license.
+ *
+ * Copyright (C) OpenMRS Inc. OpenMRS is a registered trademark and the OpenMRS
+ * graphic logo is a trademark of OpenMRS Inc.
+ */
+package org.openmrs.module.fhir2.api.search.param;
+
+import ca.uhn.fhir.rest.api.SortSpec;
+import ca.uhn.fhir.rest.param.DateRangeParam;
+import ca.uhn.fhir.rest.param.StringAndListParam;
+import ca.uhn.fhir.rest.param.TokenAndListParam;
+import lombok.Builder;
+import lombok.Data;
+import lombok.EqualsAndHashCode;
+import lombok.NoArgsConstructor;
+import org.openmrs.module.fhir2.FhirConstants;
+
+@Data
+@NoArgsConstructor
+@EqualsAndHashCode(callSuper = true)
+public class QuestionnaireSearchParams extends BaseResourceSearchParams {
+
+	private StringAndListParam name;
+
+	@Builder
+	public QuestionnaireSearchParams(StringAndListParam name,  TokenAndListParam id, DateRangeParam lastUpdated,
+	    SortSpec sort) {
+
+		super(id, lastUpdated, sort, null, null);
+
+		this.name = name;
+	}
+
+	@Override
+	public SearchParameterMap toSearchParameterMap() {
+		return baseSearchParameterMap().addParameter(FhirConstants.NAME_SEARCH_HANDLER, FhirConstants.NAME_PROPERTY,
+		    getName());
+	}
+
+}

api/src/main/java/org/openmrs/module/fhir2/api/translators/QuestionnaireTranslator.java

@@ -0,0 +1,28 @@
+/*
+ * This Source Code Form is subject to the terms of the Mozilla Public License,
+ * v. 2.0. If a copy of the MPL was not distributed with this file, You can
+ * obtain one at http://mozilla.org/MPL/2.0/. OpenMRS is also distributed under
+ * the terms of the Healthcare Disclaimer located at http://openmrs.org/license.
+ *
+ * Copyright (C) OpenMRS Inc. OpenMRS is a registered trademark and the OpenMRS
+ * graphic logo is a trademark of OpenMRS Inc.
+ */
+package org.openmrs.module.fhir2.api.translators;
+
+import javax.annotation.Nonnull;
+
+import org.hl7.fhir.r4.model.Questionnaire;
+import org.openmrs.Form;
+
+public interface QuestionnaireTranslator extends OpenmrsFhirTranslator<Form, Questionnaire> {
+
+	/**
+	 * Maps an {@link org.openmrs.Form} to a {@link Questionnaire}
+	 * 
+	 * @param form the form to translate
+	 * @return the corresponding FHIR questionnaire resource
+	 */
+	@Override
+	Questionnaire toFhirResource(@Nonnull Form form);
+
+}