001
002package ca.uhn.fhir.jpa.rp.r5;
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.r5.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="Search on the narrative of the resource")
083                        @OptionalParam(name="_text")
084                        SpecialAndListParam the_text,
085   
086
087                        @Description(shortDefinition="Classification for the study")
088                        @OptionalParam(name="classifier")
089                        TokenAndListParam theClassifier,
090   
091
092                        @Description(shortDefinition="Condition being studied")
093                        @OptionalParam(name="condition")
094                        TokenAndListParam theCondition,
095   
096
097                        @Description(shortDefinition="When the study began and ended")
098                        @OptionalParam(name="date")
099                        DateRangeParam theDate, 
100   
101
102                        @Description(shortDefinition="Detailed narrative of the study")
103                        @OptionalParam(name="description")
104                        StringAndListParam theDescription, 
105   
106
107                        @Description(shortDefinition="Inclusion and exclusion criteria")
108                        @OptionalParam(name="eligibility", targetTypes={  } )
109                        ReferenceAndListParam theEligibility, 
110   
111
112                        @Description(shortDefinition="Drugs, devices, etc. under study, as a code")
113                        @OptionalParam(name="focus-code")
114                        TokenAndListParam theFocus_code,
115   
116
117                        @Description(shortDefinition="Drugs, devices, etc. under study, as a reference")
118                        @OptionalParam(name="focus-reference", targetTypes={  } )
119                        ReferenceAndListParam theFocus_reference, 
120   
121
122                        @Description(shortDefinition="Business Identifier for study")
123                        @OptionalParam(name="identifier")
124                        TokenAndListParam theIdentifier,
125   
126
127                        @Description(shortDefinition="Used to search for the study")
128                        @OptionalParam(name="keyword")
129                        TokenAndListParam theKeyword,
130   
131
132                        @Description(shortDefinition="Name for this study")
133                        @OptionalParam(name="name")
134                        StringAndListParam theName, 
135   
136
137                        @Description(shortDefinition="Free text description of the objective of the study")
138                        @OptionalParam(name="objective-description")
139                        StringAndListParam theObjective_description, 
140   
141
142                        @Description(shortDefinition="The kind of study objective")
143                        @OptionalParam(name="objective-type")
144                        TokenAndListParam theObjective_type,
145   
146
147                        @Description(shortDefinition="Part of larger study")
148                        @OptionalParam(name="part-of", targetTypes={  } )
149                        ReferenceAndListParam thePart_of, 
150   
151
152                        @Description(shortDefinition="The stage in the progression of a study")
153                        @OptionalParam(name="phase")
154                        TokenAndListParam thePhase,
155   
156
157                        @Description(shortDefinition="Steps followed in executing study")
158                        @OptionalParam(name="protocol", targetTypes={  } )
159                        ReferenceAndListParam theProtocol, 
160   
161
162                        @Description(shortDefinition="Actual number of participants enrolled in study across all groups")
163                        @OptionalParam(name="recruitment-actual")
164                        NumberAndListParam theRecruitment_actual, 
165   
166
167                        @Description(shortDefinition="Target number of participants enrolled in study across all groups")
168                        @OptionalParam(name="recruitment-target")
169                        NumberAndListParam theRecruitment_target, 
170   
171
172                        @Description(shortDefinition="Geographic area for the study")
173                        @OptionalParam(name="region")
174                        TokenAndListParam theRegion,
175   
176
177                        @Description(shortDefinition="Facility where study activities are conducted")
178                        @OptionalParam(name="site", targetTypes={  } )
179                        ReferenceAndListParam theSite, 
180   
181
182                        @Description(shortDefinition="active | active-but-not-recruiting | administratively-completed | approved | closed-to-accrual | closed-to-accrual-and-intervention | completed | disapproved | enrolling-by-invitation | in-review | not-yet-recruiting | recruiting | temporarily-closed-to-accrual | temporarily-closed-to-accrual-and-intervention | terminated | withdrawn")
183                        @OptionalParam(name="status")
184                        TokenAndListParam theStatus,
185   
186
187                        @Description(shortDefinition="Classifications of the study design characteristics")
188                        @OptionalParam(name="study-design")
189                        TokenAndListParam theStudy_design,
190   
191
192                        @Description(shortDefinition="The human readable name of the research study")
193                        @OptionalParam(name="title")
194                        StringAndListParam theTitle, 
195
196                        @RawParam
197                        Map<String, List<String>> theAdditionalRawParams,
198
199                        @Description(shortDefinition="Only return resources which were last updated as specified by the given range")
200                        @OptionalParam(name="_lastUpdated")
201                        DateRangeParam theLastUpdated, 
202
203                        @IncludeParam
204                        Set<Include> theIncludes,
205
206                        @IncludeParam(reverse=true)
207                        Set<Include> theRevIncludes,
208
209                        @Sort
210                        SortSpec theSort,
211                        
212                        @ca.uhn.fhir.rest.annotation.Count
213                        Integer theCount,
214
215                        @ca.uhn.fhir.rest.annotation.Offset
216                        Integer theOffset,
217
218                        SummaryEnum theSummaryMode,
219
220                        SearchTotalModeEnum theSearchTotalMode,
221
222                        SearchContainedModeEnum theSearchContainedMode
223
224                        ) {
225                startRequest(theServletRequest);
226                try {
227                        SearchParameterMap paramMap = new SearchParameterMap();
228                        paramMap.add(ca.uhn.fhir.rest.api.Constants.PARAM_FILTER, theFtFilter);
229                        paramMap.add(ca.uhn.fhir.rest.api.Constants.PARAM_CONTENT, theFtContent);
230                        paramMap.add(ca.uhn.fhir.rest.api.Constants.PARAM_TEXT, theFtText);
231                        paramMap.add(ca.uhn.fhir.rest.api.Constants.PARAM_TAG, theSearchForTag);
232                        paramMap.add(ca.uhn.fhir.rest.api.Constants.PARAM_SECURITY, theSearchForSecurity);
233                        paramMap.add(ca.uhn.fhir.rest.api.Constants.PARAM_PROFILE, theSearchForProfile);
234                        paramMap.add(ca.uhn.fhir.rest.api.Constants.PARAM_SOURCE, theSearchForSource);
235                        paramMap.add(ca.uhn.fhir.rest.api.Constants.PARAM_LIST, theList);
236                        paramMap.add(ca.uhn.fhir.rest.api.Constants.PARAM_LANGUAGE, theResourceLanguage);
237
238                        paramMap.add("_has", theHas);
239                        paramMap.add("_id", the_id);
240                        paramMap.add("_text", the_text);
241                        paramMap.add("classifier", theClassifier);
242                        paramMap.add("condition", theCondition);
243                        paramMap.add("date", theDate);
244                        paramMap.add("description", theDescription);
245                        paramMap.add("eligibility", theEligibility);
246                        paramMap.add("focus-code", theFocus_code);
247                        paramMap.add("focus-reference", theFocus_reference);
248                        paramMap.add("identifier", theIdentifier);
249                        paramMap.add("keyword", theKeyword);
250                        paramMap.add("name", theName);
251                        paramMap.add("objective-description", theObjective_description);
252                        paramMap.add("objective-type", theObjective_type);
253                        paramMap.add("part-of", thePart_of);
254                        paramMap.add("phase", thePhase);
255                        paramMap.add("protocol", theProtocol);
256                        paramMap.add("recruitment-actual", theRecruitment_actual);
257                        paramMap.add("recruitment-target", theRecruitment_target);
258                        paramMap.add("region", theRegion);
259                        paramMap.add("site", theSite);
260                        paramMap.add("status", theStatus);
261                        paramMap.add("study-design", theStudy_design);
262                        paramMap.add("title", theTitle);
263                        paramMap.setRevIncludes(theRevIncludes);
264                        paramMap.setLastUpdated(theLastUpdated);
265                        paramMap.setIncludes(theIncludes);
266                        paramMap.setSort(theSort);
267                        paramMap.setCount(theCount);
268                        paramMap.setOffset(theOffset);
269                        paramMap.setSummaryMode(theSummaryMode);
270                        paramMap.setSearchTotalMode(theSearchTotalMode);
271                        paramMap.setSearchContainedMode(theSearchContainedMode);
272
273                        getDao().translateRawParameters(theAdditionalRawParams, paramMap);
274
275                        ca.uhn.fhir.rest.api.server.IBundleProvider retVal = getDao().search(paramMap, theRequestDetails, theServletResponse);
276                        return retVal;
277                } finally {
278                        endRequest(theServletRequest);
279                }
280        }
281
282}