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 DocumentReferenceResourceProvider extends 
020        ca.uhn.fhir.jpa.provider.BaseJpaResourceProvider<DocumentReference>
021        {
022
023        @Override
024        public Class<DocumentReference> getResourceType() {
025                return DocumentReference.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="Who/what authenticated the document")
092                        @OptionalParam(name="authenticator", targetTypes={  } )
093                        ReferenceAndListParam theAuthenticator, 
094   
095
096                        @Description(shortDefinition="Who and/or what authored the document")
097                        @OptionalParam(name="author", targetTypes={  } )
098                        ReferenceAndListParam theAuthor, 
099   
100
101                        @Description(shortDefinition="Categorization of document")
102                        @OptionalParam(name="category")
103                        TokenAndListParam theCategory,
104   
105
106                        @Description(shortDefinition="Mime type of the content, with charset etc.")
107                        @OptionalParam(name="contenttype")
108                        TokenAndListParam theContenttype,
109   
110
111                        @Description(shortDefinition="Organization which maintains the document")
112                        @OptionalParam(name="custodian", targetTypes={  } )
113                        ReferenceAndListParam theCustodian, 
114   
115
116                        @Description(shortDefinition="When this document reference was created")
117                        @OptionalParam(name="date")
118                        DateRangeParam theDate, 
119   
120
121                        @Description(shortDefinition="Human-readable description")
122                        @OptionalParam(name="description")
123                        StringAndListParam theDescription, 
124   
125
126                        @Description(shortDefinition="Context of the document  content")
127                        @OptionalParam(name="encounter", targetTypes={  } )
128                        ReferenceAndListParam theEncounter, 
129   
130
131                        @Description(shortDefinition="Main clinical acts documented")
132                        @OptionalParam(name="event")
133                        TokenAndListParam theEvent,
134   
135
136                        @Description(shortDefinition="Kind of facility where patient was seen")
137                        @OptionalParam(name="facility")
138                        TokenAndListParam theFacility,
139   
140
141                        @Description(shortDefinition="Format/content rules for the document")
142                        @OptionalParam(name="format")
143                        TokenAndListParam theFormat,
144   
145
146                        @Description(shortDefinition="Master Version Specific Identifier")
147                        @OptionalParam(name="identifier")
148                        TokenAndListParam theIdentifier,
149   
150
151                        @Description(shortDefinition="Human language of the content (BCP-47)")
152                        @OptionalParam(name="language")
153                        TokenAndListParam theLanguage,
154   
155
156                        @Description(shortDefinition="Uri where the data can be found")
157                        @OptionalParam(name="location")
158                        UriAndListParam theLocation, 
159   
160
161                        @Description(shortDefinition="Who/what is the subject of the document")
162                        @OptionalParam(name="patient", targetTypes={  } )
163                        ReferenceAndListParam thePatient, 
164   
165
166                        @Description(shortDefinition="Time of service that is being documented")
167                        @OptionalParam(name="period")
168                        DateRangeParam thePeriod, 
169   
170
171                        @Description(shortDefinition="Related identifiers or resources")
172                        @OptionalParam(name="related", targetTypes={  } )
173                        ReferenceAndListParam theRelated, 
174   
175
176                        @Description(shortDefinition="Target of the relationship")
177                        @OptionalParam(name="relatesto", targetTypes={  } )
178                        ReferenceAndListParam theRelatesto, 
179   
180
181                        @Description(shortDefinition="replaces | transforms | signs | appends")
182                        @OptionalParam(name="relation")
183                        TokenAndListParam theRelation,
184   
185
186                        @Description(shortDefinition="Combination of relation and relatesTo")
187                        @OptionalParam(name="relationship", compositeTypes= { ReferenceParam.class, TokenParam.class })
188                        CompositeAndListParam<ReferenceParam, TokenParam> theRelationship,
189   
190
191                        @Description(shortDefinition="Document security-tags")
192                        @OptionalParam(name="security-label")
193                        TokenAndListParam theSecurity_label,
194   
195
196                        @Description(shortDefinition="Additional details about where the content was created (e.g. clinical specialty)")
197                        @OptionalParam(name="setting")
198                        TokenAndListParam theSetting,
199   
200
201                        @Description(shortDefinition="current | superseded | entered-in-error")
202                        @OptionalParam(name="status")
203                        TokenAndListParam theStatus,
204   
205
206                        @Description(shortDefinition="Who/what is the subject of the document")
207                        @OptionalParam(name="subject", targetTypes={  } )
208                        ReferenceAndListParam theSubject, 
209   
210
211                        @Description(shortDefinition="Kind of document (LOINC if possible)")
212                        @OptionalParam(name="type")
213                        TokenAndListParam theType,
214
215                        @RawParam
216                        Map<String, List<String>> theAdditionalRawParams,
217
218        
219                        @IncludeParam
220                        Set<Include> theIncludes,
221
222                        @IncludeParam(reverse=true)
223                        Set<Include> theRevIncludes,
224
225                        @Sort
226                        SortSpec theSort,
227                        
228                        @ca.uhn.fhir.rest.annotation.Count
229                        Integer theCount,
230
231                        @ca.uhn.fhir.rest.annotation.Offset
232                        Integer theOffset,
233
234                        SummaryEnum theSummaryMode,
235
236                        SearchTotalModeEnum theSearchTotalMode,
237
238                        SearchContainedModeEnum theSearchContainedMode
239
240                        ) {
241                startRequest(theServletRequest);
242                try {
243                        SearchParameterMap paramMap = new SearchParameterMap();
244                        paramMap.add(ca.uhn.fhir.rest.api.Constants.PARAM_FILTER, theFtFilter);
245                        paramMap.add(ca.uhn.fhir.rest.api.Constants.PARAM_CONTENT, theFtContent);
246                        paramMap.add(ca.uhn.fhir.rest.api.Constants.PARAM_TEXT, theFtText);
247                        paramMap.add(ca.uhn.fhir.rest.api.Constants.PARAM_SOURCE, theSearchForSource);
248                        paramMap.add(ca.uhn.fhir.rest.api.Constants.PARAM_LIST, theList);
249                        paramMap.add(ca.uhn.fhir.rest.api.Constants.PARAM_LANGUAGE, theResourceLanguage);
250
251                        paramMap.add("_has", theHas);
252                                paramMap.add("_id", the_id);
253                                                                paramMap.add("_profile", the_profile);
254                                paramMap.add("_security", the_security);
255                                paramMap.add("_tag", the_tag);
256                                paramMap.add("authenticator", theAuthenticator);
257                                paramMap.add("author", theAuthor);
258                                paramMap.add("category", theCategory);
259                                paramMap.add("contenttype", theContenttype);
260                                paramMap.add("custodian", theCustodian);
261                                paramMap.add("date", theDate);
262                                paramMap.add("description", theDescription);
263                                paramMap.add("encounter", theEncounter);
264                                paramMap.add("event", theEvent);
265                                paramMap.add("facility", theFacility);
266                                paramMap.add("format", theFormat);
267                                paramMap.add("identifier", theIdentifier);
268                                paramMap.add("language", theLanguage);
269                                paramMap.add("location", theLocation);
270                                paramMap.add("patient", thePatient);
271                                paramMap.add("period", thePeriod);
272                                paramMap.add("related", theRelated);
273                                paramMap.add("relatesto", theRelatesto);
274                                paramMap.add("relation", theRelation);
275                                paramMap.add("relationship", theRelationship);
276                                paramMap.add("security-label", theSecurity_label);
277                                paramMap.add("setting", theSetting);
278                                paramMap.add("status", theStatus);
279                                paramMap.add("subject", theSubject);
280                                paramMap.add("type", theType);
281paramMap.setRevIncludes(theRevIncludes);
282                        paramMap.setLastUpdated(the_lastUpdated);
283                        paramMap.setIncludes(theIncludes);
284                        paramMap.setSort(theSort);
285                        paramMap.setCount(theCount);
286                        paramMap.setOffset(theOffset);
287                        paramMap.setSummaryMode(theSummaryMode);
288                        paramMap.setSearchTotalMode(theSearchTotalMode);
289                        paramMap.setSearchContainedMode(theSearchContainedMode);
290
291                        getDao().translateRawParameters(theAdditionalRawParams, paramMap);
292
293                        ca.uhn.fhir.rest.api.server.IBundleProvider retVal = getDao().search(paramMap, theRequestDetails, theServletResponse);
294                        return retVal;
295                } finally {
296                        endRequest(theServletRequest);
297                }
298        }
299
300}