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