001
002package ca.uhn.fhir.jpa.rp.r4b;
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.r4b.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="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                        StringAndListParam the_text, 
105   
106
107                        @Description(shortDefinition="Who/what authenticated the document")
108                        @OptionalParam(name="authenticator", targetTypes={  } )
109                        ReferenceAndListParam theAuthenticator, 
110   
111
112                        @Description(shortDefinition="Who and/or what authored the document")
113                        @OptionalParam(name="author", targetTypes={  } )
114                        ReferenceAndListParam theAuthor, 
115   
116
117                        @Description(shortDefinition="Categorization of document")
118                        @OptionalParam(name="category")
119                        TokenAndListParam theCategory,
120   
121
122                        @Description(shortDefinition="Mime type of the content, with charset etc.")
123                        @OptionalParam(name="contenttype")
124                        TokenAndListParam theContenttype,
125   
126
127                        @Description(shortDefinition="Organization which maintains the document")
128                        @OptionalParam(name="custodian", targetTypes={  } )
129                        ReferenceAndListParam theCustodian, 
130   
131
132                        @Description(shortDefinition="When this document reference was created")
133                        @OptionalParam(name="date")
134                        DateRangeParam theDate, 
135   
136
137                        @Description(shortDefinition="Human-readable description")
138                        @OptionalParam(name="description")
139                        StringAndListParam theDescription, 
140   
141
142                        @Description(shortDefinition="Multiple Resources: * [Composition](composition.html): Context of the Composition* [DeviceRequest](devicerequest.html): Encounter during which request was created* [DiagnosticReport](diagnosticreport.html): The Encounter when the order was made* [DocumentReference](documentreference.html): Context of the document  content* [Flag](flag.html): Alert relevant during encounter* [List](list.html): Context in which list created* [NutritionOrder](nutritionorder.html): Return nutrition orders with this encounter identifier* [Observation](observation.html): Encounter related to the observation* [Procedure](procedure.html): Encounter created as part of* [RiskAssessment](riskassessment.html): Where was assessment performed?* [ServiceRequest](servicerequest.html): An encounter in which this request is made* [VisionPrescription](visionprescription.html): Return prescriptions with this encounter identifier")
143                        @OptionalParam(name="encounter", targetTypes={  } )
144                        ReferenceAndListParam theEncounter, 
145   
146
147                        @Description(shortDefinition="Main clinical acts documented")
148                        @OptionalParam(name="event")
149                        TokenAndListParam theEvent,
150   
151
152                        @Description(shortDefinition="Kind of facility where patient was seen")
153                        @OptionalParam(name="facility")
154                        TokenAndListParam theFacility,
155   
156
157                        @Description(shortDefinition="Format/content rules for the document")
158                        @OptionalParam(name="format")
159                        TokenAndListParam theFormat,
160   
161
162                        @Description(shortDefinition="Multiple Resources: * [AllergyIntolerance](allergyintolerance.html): External ids for this item* [CarePlan](careplan.html): External Ids for this plan* [CareTeam](careteam.html): External Ids for this team* [Composition](composition.html): Version-independent identifier for the Composition* [Condition](condition.html): A unique identifier of the condition record* [Consent](consent.html): Identifier for this record (external references)* [DetectedIssue](detectedissue.html): Unique id for the detected issue* [DeviceRequest](devicerequest.html): Business identifier for request/order* [DiagnosticReport](diagnosticreport.html): An identifier for the report* [DocumentManifest](documentmanifest.html): Unique Identifier for the set of documents* [DocumentReference](documentreference.html): Master Version Specific Identifier* [Encounter](encounter.html): Identifier(s) by which this encounter is known* [EpisodeOfCare](episodeofcare.html): Business Identifier(s) relevant for this EpisodeOfCare* [FamilyMemberHistory](familymemberhistory.html): A search by a record identifier* [Goal](goal.html): External Ids for this goal* [ImagingStudy](imagingstudy.html): Identifiers for the Study, such as DICOM Study Instance UID and Accession number* [Immunization](immunization.html): Business identifier* [List](list.html): Business identifier* [MedicationAdministration](medicationadministration.html): Return administrations with this external identifier* [MedicationDispense](medicationdispense.html): Returns dispenses with this external identifier* [MedicationRequest](medicationrequest.html): Return prescriptions with this external identifier* [MedicationStatement](medicationstatement.html): Return statements with this external identifier* [NutritionOrder](nutritionorder.html): Return nutrition orders with this external identifier* [Observation](observation.html): The unique id for a particular observation* [Procedure](procedure.html): A unique identifier for a procedure* [RiskAssessment](riskassessment.html): Unique identifier for the assessment* [ServiceRequest](servicerequest.html): Identifiers assigned to this order* [SupplyDelivery](supplydelivery.html): External identifier* [SupplyRequest](supplyrequest.html): Business Identifier for SupplyRequest* [VisionPrescription](visionprescription.html): Return prescriptions with this external identifier")
163                        @OptionalParam(name="identifier")
164                        TokenAndListParam theIdentifier,
165   
166
167                        @Description(shortDefinition="Human language of the content (BCP-47)")
168                        @OptionalParam(name="language")
169                        TokenAndListParam theLanguage,
170   
171
172                        @Description(shortDefinition="Uri where the data can be found")
173                        @OptionalParam(name="location")
174                        UriAndListParam theLocation, 
175   
176
177                        @Description(shortDefinition="Multiple Resources: * [AllergyIntolerance](allergyintolerance.html): Who the sensitivity is for* [CarePlan](careplan.html): Who the care plan is for* [CareTeam](careteam.html): Who care team is for* [ClinicalImpression](clinicalimpression.html): Patient or group assessed* [Composition](composition.html): Who and/or what the composition is about* [Condition](condition.html): Who has the condition?* [Consent](consent.html): Who the consent applies to* [DetectedIssue](detectedissue.html): Associated patient* [DeviceRequest](devicerequest.html): Individual the service is ordered for* [DeviceUseStatement](deviceusestatement.html): Search by subject - a patient* [DiagnosticReport](diagnosticreport.html): The subject of the report if a patient* [DocumentManifest](documentmanifest.html): The subject of the set of documents* [DocumentReference](documentreference.html): Who/what is the subject of the document* [Encounter](encounter.html): The patient or group present at the encounter* [EpisodeOfCare](episodeofcare.html): The patient who is the focus of this episode of care* [FamilyMemberHistory](familymemberhistory.html): The identity of a subject to list family member history items for* [Flag](flag.html): The identity of a subject to list flags for* [Goal](goal.html): Who this goal is intended for* [ImagingStudy](imagingstudy.html): Who the study is about* [Immunization](immunization.html): The patient for the vaccination record* [List](list.html): If all resources have the same subject* [MedicationAdministration](medicationadministration.html): The identity of a patient to list administrations  for* [MedicationDispense](medicationdispense.html): The identity of a patient to list dispenses  for* [MedicationRequest](medicationrequest.html): Returns prescriptions for a specific patient* [MedicationStatement](medicationstatement.html): Returns statements for a specific patient.* [NutritionOrder](nutritionorder.html): The identity of the person who requires the diet, formula or nutritional supplement* [Observation](observation.html): The subject that the observation is about (if patient)* [Procedure](procedure.html): Search by subject - a patient* [RiskAssessment](riskassessment.html): Who/what does assessment apply to?* [ServiceRequest](servicerequest.html): Search by subject - a patient* [SupplyDelivery](supplydelivery.html): Patient for whom the item is supplied* [VisionPrescription](visionprescription.html): The identity of a patient to list dispenses for")
178                        @OptionalParam(name="patient", targetTypes={  } )
179                        ReferenceAndListParam thePatient, 
180   
181
182                        @Description(shortDefinition="Time of service that is being documented")
183                        @OptionalParam(name="period")
184                        DateRangeParam thePeriod, 
185   
186
187                        @Description(shortDefinition="Related identifiers or resources")
188                        @OptionalParam(name="related", targetTypes={  } )
189                        ReferenceAndListParam theRelated, 
190   
191
192                        @Description(shortDefinition="Target of the relationship")
193                        @OptionalParam(name="relatesto", targetTypes={  } )
194                        ReferenceAndListParam theRelatesto, 
195   
196
197                        @Description(shortDefinition="replaces | transforms | signs | appends")
198                        @OptionalParam(name="relation")
199                        TokenAndListParam theRelation,
200   
201
202                        @Description(shortDefinition="Combination of relation and relatesTo")
203                        @OptionalParam(name="relationship", compositeTypes= { ReferenceParam.class, TokenParam.class })
204                        CompositeAndListParam<ReferenceParam, TokenParam> theRelationship,
205   
206
207                        @Description(shortDefinition="Document security-tags")
208                        @OptionalParam(name="security-label")
209                        TokenAndListParam theSecurity_label,
210   
211
212                        @Description(shortDefinition="Additional details about where the content was created (e.g. clinical specialty)")
213                        @OptionalParam(name="setting")
214                        TokenAndListParam theSetting,
215   
216
217                        @Description(shortDefinition="current | superseded | entered-in-error")
218                        @OptionalParam(name="status")
219                        TokenAndListParam theStatus,
220   
221
222                        @Description(shortDefinition="Who/what is the subject of the document")
223                        @OptionalParam(name="subject", targetTypes={  } )
224                        ReferenceAndListParam theSubject, 
225   
226
227                        @Description(shortDefinition="Multiple Resources: * [AllergyIntolerance](allergyintolerance.html): allergy | intolerance - Underlying mechanism (if known)* [Composition](composition.html): Kind of composition (LOINC if possible)* [DocumentManifest](documentmanifest.html): Kind of document set* [DocumentReference](documentreference.html): Kind of document (LOINC if possible)* [Encounter](encounter.html): Specific type of encounter* [EpisodeOfCare](episodeofcare.html): Type/class  - e.g. specialist referral, disease management")
228                        @OptionalParam(name="type")
229                        TokenAndListParam theType,
230
231                        @RawParam
232                        Map<String, List<String>> theAdditionalRawParams,
233
234        
235                        @IncludeParam
236                        Set<Include> theIncludes,
237
238                        @IncludeParam(reverse=true)
239                        Set<Include> theRevIncludes,
240
241                        @Sort
242                        SortSpec theSort,
243                        
244                        @ca.uhn.fhir.rest.annotation.Count
245                        Integer theCount,
246
247                        @ca.uhn.fhir.rest.annotation.Offset
248                        Integer theOffset,
249
250                        SummaryEnum theSummaryMode,
251
252                        SearchTotalModeEnum theSearchTotalMode,
253
254                        SearchContainedModeEnum theSearchContainedMode
255
256                        ) {
257                startRequest(theServletRequest);
258                try {
259                        SearchParameterMap paramMap = new SearchParameterMap();
260                        paramMap.add(ca.uhn.fhir.rest.api.Constants.PARAM_FILTER, theFtFilter);
261                        paramMap.add(ca.uhn.fhir.rest.api.Constants.PARAM_CONTENT, theFtContent);
262                        paramMap.add(ca.uhn.fhir.rest.api.Constants.PARAM_TEXT, theFtText);
263                        paramMap.add(ca.uhn.fhir.rest.api.Constants.PARAM_TAG, theSearchForTag);
264                        paramMap.add(ca.uhn.fhir.rest.api.Constants.PARAM_SECURITY, theSearchForSecurity);
265                        paramMap.add(ca.uhn.fhir.rest.api.Constants.PARAM_PROFILE, theSearchForProfile);
266                        paramMap.add(ca.uhn.fhir.rest.api.Constants.PARAM_SOURCE, theSearchForSource);
267                        paramMap.add(ca.uhn.fhir.rest.api.Constants.PARAM_LIST, theList);
268                        paramMap.add(ca.uhn.fhir.rest.api.Constants.PARAM_LANGUAGE, theResourceLanguage);
269
270                        paramMap.add("_has", theHas);
271                                paramMap.add("_id", the_id);
272                                                                paramMap.add("_profile", the_profile);
273                                paramMap.add("_security", the_security);
274                                paramMap.add("_tag", the_tag);
275                                paramMap.add("_text", the_text);
276                                paramMap.add("authenticator", theAuthenticator);
277                                paramMap.add("author", theAuthor);
278                                paramMap.add("category", theCategory);
279                                paramMap.add("contenttype", theContenttype);
280                                paramMap.add("custodian", theCustodian);
281                                paramMap.add("date", theDate);
282                                paramMap.add("description", theDescription);
283                                paramMap.add("encounter", theEncounter);
284                                paramMap.add("event", theEvent);
285                                paramMap.add("facility", theFacility);
286                                paramMap.add("format", theFormat);
287                                paramMap.add("identifier", theIdentifier);
288                                paramMap.add("language", theLanguage);
289                                paramMap.add("location", theLocation);
290                                paramMap.add("patient", thePatient);
291                                paramMap.add("period", thePeriod);
292                                paramMap.add("related", theRelated);
293                                paramMap.add("relatesto", theRelatesto);
294                                paramMap.add("relation", theRelation);
295                                paramMap.add("relationship", theRelationship);
296                                paramMap.add("security-label", theSecurity_label);
297                                paramMap.add("setting", theSetting);
298                                paramMap.add("status", theStatus);
299                                paramMap.add("subject", theSubject);
300                                paramMap.add("type", theType);
301paramMap.setRevIncludes(theRevIncludes);
302                        paramMap.setLastUpdated(the_lastUpdated);
303                        paramMap.setIncludes(theIncludes);
304                        paramMap.setSort(theSort);
305                        paramMap.setCount(theCount);
306                        paramMap.setOffset(theOffset);
307                        paramMap.setSummaryMode(theSummaryMode);
308                        paramMap.setSearchTotalMode(theSearchTotalMode);
309                        paramMap.setSearchContainedMode(theSearchContainedMode);
310
311                        getDao().translateRawParameters(theAdditionalRawParams, paramMap);
312
313                        ca.uhn.fhir.rest.api.server.IBundleProvider retVal = getDao().search(paramMap, theRequestDetails, theServletResponse);
314                        return retVal;
315                } finally {
316                        endRequest(theServletRequest);
317                }
318        }
319
320}