001
002package ca.uhn.fhir.jpa.rp.r4;
003
004import java.util.*;
005
006import org.apache.commons.lang3.StringUtils;
007
008import ca.uhn.fhir.jpa.searchparam.SearchParameterMap;
009import ca.uhn.fhir.model.api.Include;
010import ca.uhn.fhir.model.api.annotation.*;
011import org.hl7.fhir.r4.model.*;
012import ca.uhn.fhir.rest.annotation.*;
013import ca.uhn.fhir.rest.param.*;
014import ca.uhn.fhir.rest.api.SortSpec;
015import ca.uhn.fhir.rest.api.SummaryEnum;
016import ca.uhn.fhir.rest.api.SearchTotalModeEnum;
017import ca.uhn.fhir.rest.api.SearchContainedModeEnum;
018
019public class ResearchStudyResourceProvider extends 
020        ca.uhn.fhir.jpa.provider.BaseJpaResourceProvider<ResearchStudy>
021        {
022
023        @Override
024        public Class<ResearchStudy> getResourceType() {
025                return ResearchStudy.class;
026        }
027
028        @Search(allowUnknownParams=true)
029        public ca.uhn.fhir.rest.api.server.IBundleProvider search(
030                        jakarta.servlet.http.HttpServletRequest theServletRequest,
031                        jakarta.servlet.http.HttpServletResponse theServletResponse,
032
033                        ca.uhn.fhir.rest.api.server.RequestDetails theRequestDetails,
034
035                        @Description(shortDefinition="Search the contents of the resource's data using a filter")
036                        @OptionalParam(name=ca.uhn.fhir.rest.api.Constants.PARAM_FILTER)
037                        StringAndListParam theFtFilter,
038
039                        @Description(shortDefinition="Search the contents of the resource's data using a fulltext search")
040                        @OptionalParam(name=ca.uhn.fhir.rest.api.Constants.PARAM_CONTENT)
041                        StringAndListParam theFtContent, 
042
043                        @Description(shortDefinition="Search the contents of the resource's narrative using a fulltext search")
044                        @OptionalParam(name=ca.uhn.fhir.rest.api.Constants.PARAM_TEXT)
045                        StringAndListParam theFtText, 
046
047                        @Description(shortDefinition="Search for resources which have the given tag")
048                        @OptionalParam(name=ca.uhn.fhir.rest.api.Constants.PARAM_TAG)
049                        TokenAndListParam theSearchForTag, 
050
051                        @Description(shortDefinition="Search for resources which have the given security labels")
052                        @OptionalParam(name=ca.uhn.fhir.rest.api.Constants.PARAM_SECURITY)
053                        TokenAndListParam theSearchForSecurity, 
054  
055                        @Description(shortDefinition="Search for resources which have the given profile")
056                        @OptionalParam(name=ca.uhn.fhir.rest.api.Constants.PARAM_PROFILE)
057                        UriAndListParam theSearchForProfile,
058
059                        @Description(shortDefinition="Search the contents of the resource's data using a list")
060                        @OptionalParam(name=ca.uhn.fhir.rest.api.Constants.PARAM_LIST)
061                        StringAndListParam theList,
062
063                        @Description(shortDefinition="The language of the resource")
064                        @OptionalParam(name=ca.uhn.fhir.rest.api.Constants.PARAM_LANGUAGE)
065                        TokenAndListParam theResourceLanguage,
066
067                        @Description(shortDefinition="Search for resources which have the given source value (Resource.meta.source)")
068                        @OptionalParam(name=ca.uhn.fhir.rest.api.Constants.PARAM_SOURCE)
069                        UriAndListParam theSearchForSource,
070
071                        @Description(shortDefinition="Return resources linked to by the given target")
072                        @OptionalParam(name="_has")
073                        HasAndListParam theHas, 
074
075   
076
077                        @Description(shortDefinition="The ID of the resource")
078                        @OptionalParam(name="_id")
079                        TokenAndListParam the_id,
080   
081
082                        @Description(shortDefinition="Only return resources which were last updated as specified by the given range")
083                        @OptionalParam(name="_lastUpdated")
084                        DateRangeParam the_lastUpdated, 
085   
086
087                        @Description(shortDefinition="The profile of the resource")
088                        @OptionalParam(name="_profile")
089                        UriAndListParam the_profile, 
090   
091
092                        @Description(shortDefinition="The security of the resource")
093                        @OptionalParam(name="_security")
094                        TokenAndListParam the_security,
095   
096
097                        @Description(shortDefinition="The tag of the resource")
098                        @OptionalParam(name="_tag")
099                        TokenAndListParam the_tag,
100   
101
102                        @Description(shortDefinition="Classifications for the study")
103                        @OptionalParam(name="category")
104                        TokenAndListParam theCategory,
105   
106
107                        @Description(shortDefinition="When the study began and ended")
108                        @OptionalParam(name="date")
109                        DateRangeParam theDate, 
110   
111
112                        @Description(shortDefinition="Drugs, devices, etc. under study")
113                        @OptionalParam(name="focus")
114                        TokenAndListParam theFocus,
115   
116
117                        @Description(shortDefinition="Business Identifier for study")
118                        @OptionalParam(name="identifier")
119                        TokenAndListParam theIdentifier,
120   
121
122                        @Description(shortDefinition="Used to search for the study")
123                        @OptionalParam(name="keyword")
124                        TokenAndListParam theKeyword,
125   
126
127                        @Description(shortDefinition="Geographic region(s) for study")
128                        @OptionalParam(name="location")
129                        TokenAndListParam theLocation,
130   
131
132                        @Description(shortDefinition="Part of larger study")
133                        @OptionalParam(name="partof", targetTypes={  } )
134                        ReferenceAndListParam thePartof, 
135   
136
137                        @Description(shortDefinition="Researcher who oversees multiple aspects of the study")
138                        @OptionalParam(name="principalinvestigator", targetTypes={  } )
139                        ReferenceAndListParam thePrincipalinvestigator, 
140   
141
142                        @Description(shortDefinition="Steps followed in executing study")
143                        @OptionalParam(name="protocol", targetTypes={  } )
144                        ReferenceAndListParam theProtocol, 
145   
146
147                        @Description(shortDefinition="Facility where study activities are conducted")
148                        @OptionalParam(name="site", targetTypes={  } )
149                        ReferenceAndListParam theSite, 
150   
151
152                        @Description(shortDefinition="Organization that initiates and is legally responsible for the study")
153                        @OptionalParam(name="sponsor", targetTypes={  } )
154                        ReferenceAndListParam theSponsor, 
155   
156
157                        @Description(shortDefinition="active | administratively-completed | approved | closed-to-accrual | closed-to-accrual-and-intervention | completed | disapproved | in-review | temporarily-closed-to-accrual | temporarily-closed-to-accrual-and-intervention | withdrawn")
158                        @OptionalParam(name="status")
159                        TokenAndListParam theStatus,
160   
161
162                        @Description(shortDefinition="Name for this study")
163                        @OptionalParam(name="title")
164                        StringAndListParam theTitle, 
165
166                        @RawParam
167                        Map<String, List<String>> theAdditionalRawParams,
168
169        
170                        @IncludeParam
171                        Set<Include> theIncludes,
172
173                        @IncludeParam(reverse=true)
174                        Set<Include> theRevIncludes,
175
176                        @Sort
177                        SortSpec theSort,
178                        
179                        @ca.uhn.fhir.rest.annotation.Count
180                        Integer theCount,
181
182                        @ca.uhn.fhir.rest.annotation.Offset
183                        Integer theOffset,
184
185                        SummaryEnum theSummaryMode,
186
187                        SearchTotalModeEnum theSearchTotalMode,
188
189                        SearchContainedModeEnum theSearchContainedMode
190
191                        ) {
192                startRequest(theServletRequest);
193                try {
194                        SearchParameterMap paramMap = new SearchParameterMap();
195                        paramMap.add(ca.uhn.fhir.rest.api.Constants.PARAM_FILTER, theFtFilter);
196                        paramMap.add(ca.uhn.fhir.rest.api.Constants.PARAM_CONTENT, theFtContent);
197                        paramMap.add(ca.uhn.fhir.rest.api.Constants.PARAM_TEXT, theFtText);
198                        paramMap.add(ca.uhn.fhir.rest.api.Constants.PARAM_TAG, theSearchForTag);
199                        paramMap.add(ca.uhn.fhir.rest.api.Constants.PARAM_SECURITY, theSearchForSecurity);
200                        paramMap.add(ca.uhn.fhir.rest.api.Constants.PARAM_PROFILE, theSearchForProfile);
201                        paramMap.add(ca.uhn.fhir.rest.api.Constants.PARAM_SOURCE, theSearchForSource);
202                        paramMap.add(ca.uhn.fhir.rest.api.Constants.PARAM_LIST, theList);
203                        paramMap.add(ca.uhn.fhir.rest.api.Constants.PARAM_LANGUAGE, theResourceLanguage);
204
205                        paramMap.add("_has", theHas);
206                                paramMap.add("_id", the_id);
207                                                                paramMap.add("_profile", the_profile);
208                                paramMap.add("_security", the_security);
209                                paramMap.add("_tag", the_tag);
210                                paramMap.add("category", theCategory);
211                                paramMap.add("date", theDate);
212                                paramMap.add("focus", theFocus);
213                                paramMap.add("identifier", theIdentifier);
214                                paramMap.add("keyword", theKeyword);
215                                paramMap.add("location", theLocation);
216                                paramMap.add("partof", thePartof);
217                                paramMap.add("principalinvestigator", thePrincipalinvestigator);
218                                paramMap.add("protocol", theProtocol);
219                                paramMap.add("site", theSite);
220                                paramMap.add("sponsor", theSponsor);
221                                paramMap.add("status", theStatus);
222                                paramMap.add("title", theTitle);
223paramMap.setRevIncludes(theRevIncludes);
224                        paramMap.setLastUpdated(the_lastUpdated);
225                        paramMap.setIncludes(theIncludes);
226                        paramMap.setSort(theSort);
227                        paramMap.setCount(theCount);
228                        paramMap.setOffset(theOffset);
229                        paramMap.setSummaryMode(theSummaryMode);
230                        paramMap.setSearchTotalMode(theSearchTotalMode);
231                        paramMap.setSearchContainedMode(theSearchContainedMode);
232
233                        getDao().translateRawParameters(theAdditionalRawParams, paramMap);
234
235                        ca.uhn.fhir.rest.api.server.IBundleProvider retVal = getDao().search(paramMap, theRequestDetails, theServletResponse);
236                        return retVal;
237                } finally {
238                        endRequest(theServletRequest);
239                }
240        }
241
242}