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