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 SearchParameterResourceProvider extends 
020        ca.uhn.fhir.jpa.provider.BaseJpaResourceProvider<SearchParameter>
021        {
022
023        @Override
024        public Class<SearchParameter> getResourceType() {
025                return SearchParameter.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="The resource type(s) this search parameter applies to")
083                        @OptionalParam(name="base")
084                        TokenAndListParam theBase,
085   
086
087                        @Description(shortDefinition="Code used in URL")
088                        @OptionalParam(name="code")
089                        TokenAndListParam theCode,
090   
091
092                        @Description(shortDefinition="Defines how the part works")
093                        @OptionalParam(name="component", targetTypes={  } )
094                        ReferenceAndListParam theComponent, 
095   
096
097                        @Description(shortDefinition="A use context assigned to the search parameter")
098                        @OptionalParam(name="context")
099                        TokenAndListParam theContext,
100   
101
102                        @Description(shortDefinition="A quantity- or range-valued use context assigned to the search parameter")
103                        @OptionalParam(name="context-quantity")
104                        QuantityAndListParam theContext_quantity, 
105   
106
107                        @Description(shortDefinition="A type of use context assigned to the search parameter")
108                        @OptionalParam(name="context-type")
109                        TokenAndListParam theContext_type,
110   
111
112                        @Description(shortDefinition="A use context type and quantity- or range-based value assigned to the search parameter")
113                        @OptionalParam(name="context-type-quantity", compositeTypes= { TokenParam.class, QuantityParam.class })
114                        CompositeAndListParam<TokenParam, QuantityParam> theContext_type_quantity,
115   
116
117                        @Description(shortDefinition="A use context type and value assigned to the search parameter")
118                        @OptionalParam(name="context-type-value", compositeTypes= { TokenParam.class, TokenParam.class })
119                        CompositeAndListParam<TokenParam, TokenParam> theContext_type_value,
120   
121
122                        @Description(shortDefinition="The search parameter publication date")
123                        @OptionalParam(name="date")
124                        DateRangeParam theDate, 
125   
126
127                        @Description(shortDefinition="Original definition for the search parameter")
128                        @OptionalParam(name="derived-from", targetTypes={  } )
129                        ReferenceAndListParam theDerived_from, 
130   
131
132                        @Description(shortDefinition="The description of the search parameter")
133                        @OptionalParam(name="description")
134                        StringAndListParam theDescription, 
135   
136
137                        @Description(shortDefinition="Intended jurisdiction for the search parameter")
138                        @OptionalParam(name="jurisdiction")
139                        TokenAndListParam theJurisdiction,
140   
141
142                        @Description(shortDefinition="Computationally friendly name of the search parameter")
143                        @OptionalParam(name="name")
144                        StringAndListParam theName, 
145   
146
147                        @Description(shortDefinition="Name of the publisher of the search parameter")
148                        @OptionalParam(name="publisher")
149                        StringAndListParam thePublisher, 
150   
151
152                        @Description(shortDefinition="The current status of the search parameter")
153                        @OptionalParam(name="status")
154                        TokenAndListParam theStatus,
155   
156
157                        @Description(shortDefinition="Types of resource (if a resource reference)")
158                        @OptionalParam(name="target")
159                        TokenAndListParam theTarget,
160   
161
162                        @Description(shortDefinition="number | date | string | token | reference | composite | quantity | uri | special")
163                        @OptionalParam(name="type")
164                        TokenAndListParam theType,
165   
166
167                        @Description(shortDefinition="The uri that identifies the search parameter")
168                        @OptionalParam(name="url")
169                        UriAndListParam theUrl, 
170   
171
172                        @Description(shortDefinition="The business version of the search parameter")
173                        @OptionalParam(name="version")
174                        TokenAndListParam theVersion,
175
176                        @RawParam
177                        Map<String, List<String>> theAdditionalRawParams,
178
179                        @Description(shortDefinition="Only return resources which were last updated as specified by the given range")
180                        @OptionalParam(name="_lastUpdated")
181                        DateRangeParam theLastUpdated, 
182
183                        @IncludeParam
184                        Set<Include> theIncludes,
185
186                        @IncludeParam(reverse=true)
187                        Set<Include> theRevIncludes,
188
189                        @Sort
190                        SortSpec theSort,
191                        
192                        @ca.uhn.fhir.rest.annotation.Count
193                        Integer theCount,
194
195                        @ca.uhn.fhir.rest.annotation.Offset
196                        Integer theOffset,
197
198                        SummaryEnum theSummaryMode,
199
200                        SearchTotalModeEnum theSearchTotalMode,
201
202                        SearchContainedModeEnum theSearchContainedMode
203
204                        ) {
205                startRequest(theServletRequest);
206                try {
207                        SearchParameterMap paramMap = new SearchParameterMap();
208                        paramMap.add(ca.uhn.fhir.rest.api.Constants.PARAM_FILTER, theFtFilter);
209                        paramMap.add(ca.uhn.fhir.rest.api.Constants.PARAM_CONTENT, theFtContent);
210                        paramMap.add(ca.uhn.fhir.rest.api.Constants.PARAM_TEXT, theFtText);
211                        paramMap.add(ca.uhn.fhir.rest.api.Constants.PARAM_TAG, theSearchForTag);
212                        paramMap.add(ca.uhn.fhir.rest.api.Constants.PARAM_SECURITY, theSearchForSecurity);
213                        paramMap.add(ca.uhn.fhir.rest.api.Constants.PARAM_PROFILE, theSearchForProfile);
214                        paramMap.add(ca.uhn.fhir.rest.api.Constants.PARAM_SOURCE, theSearchForSource);
215                        paramMap.add(ca.uhn.fhir.rest.api.Constants.PARAM_LIST, theList);
216                        paramMap.add(ca.uhn.fhir.rest.api.Constants.PARAM_LANGUAGE, theResourceLanguage);
217
218                        paramMap.add("_has", theHas);
219                        paramMap.add("_id", the_id);
220                        paramMap.add("base", theBase);
221                        paramMap.add("code", theCode);
222                        paramMap.add("component", theComponent);
223                        paramMap.add("context", theContext);
224                        paramMap.add("context-quantity", theContext_quantity);
225                        paramMap.add("context-type", theContext_type);
226                        paramMap.add("context-type-quantity", theContext_type_quantity);
227                        paramMap.add("context-type-value", theContext_type_value);
228                        paramMap.add("date", theDate);
229                        paramMap.add("derived-from", theDerived_from);
230                        paramMap.add("description", theDescription);
231                        paramMap.add("jurisdiction", theJurisdiction);
232                        paramMap.add("name", theName);
233                        paramMap.add("publisher", thePublisher);
234                        paramMap.add("status", theStatus);
235                        paramMap.add("target", theTarget);
236                        paramMap.add("type", theType);
237                        paramMap.add("url", theUrl);
238                        paramMap.add("version", theVersion);
239                        paramMap.setRevIncludes(theRevIncludes);
240                        paramMap.setLastUpdated(theLastUpdated);
241                        paramMap.setIncludes(theIncludes);
242                        paramMap.setSort(theSort);
243                        paramMap.setCount(theCount);
244                        paramMap.setOffset(theOffset);
245                        paramMap.setSummaryMode(theSummaryMode);
246                        paramMap.setSearchTotalMode(theSearchTotalMode);
247                        paramMap.setSearchContainedMode(theSearchContainedMode);
248
249                        getDao().translateRawParameters(theAdditionalRawParams, paramMap);
250
251                        ca.uhn.fhir.rest.api.server.IBundleProvider retVal = getDao().search(paramMap, theRequestDetails, theServletResponse);
252                        return retVal;
253                } finally {
254                        endRequest(theServletRequest);
255                }
256        }
257
258}