Source code

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