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.provider.r5.*;
009import ca.uhn.fhir.jpa.searchparam.SearchParameterMap;
010import ca.uhn.fhir.model.api.Include;
011import ca.uhn.fhir.model.api.annotation.*;
012import org.hl7.fhir.r5.model.*;
013import ca.uhn.fhir.rest.annotation.*;
014import ca.uhn.fhir.rest.param.*;
015import ca.uhn.fhir.rest.api.SortSpec;
016import ca.uhn.fhir.rest.api.SummaryEnum;
017import ca.uhn.fhir.rest.api.SearchTotalModeEnum;
018import ca.uhn.fhir.rest.api.SearchContainedModeEnum;
019
020public class DocumentReferenceResourceProvider extends 
021        JpaResourceProviderR5<DocumentReference>
022        {
023
024        @Override
025        public Class<DocumentReference> getResourceType() {
026                return DocumentReference.class;
027        }
028
029        @Search(allowUnknownParams=true)
030        public ca.uhn.fhir.rest.api.server.IBundleProvider search(
031                        javax.servlet.http.HttpServletRequest theServletRequest,
032                        javax.servlet.http.HttpServletResponse theServletResponse,
033
034                        ca.uhn.fhir.rest.api.server.RequestDetails theRequestDetails,
035
036                        @Description(shortDefinition="Search the contents of the resource's data using a filter")
037                        @OptionalParam(name=ca.uhn.fhir.rest.api.Constants.PARAM_FILTER)
038                        StringAndListParam theFtFilter,
039
040                        @Description(shortDefinition="Search the contents of the resource's data using a fulltext search")
041                        @OptionalParam(name=ca.uhn.fhir.rest.api.Constants.PARAM_CONTENT)
042                        StringAndListParam theFtContent, 
043
044                        @Description(shortDefinition="Search the contents of the resource's narrative using a fulltext search")
045                        @OptionalParam(name=ca.uhn.fhir.rest.api.Constants.PARAM_TEXT)
046                        StringAndListParam theFtText, 
047
048                        @Description(shortDefinition="Search for resources which have the given tag")
049                        @OptionalParam(name=ca.uhn.fhir.rest.api.Constants.PARAM_TAG)
050                        TokenAndListParam theSearchForTag, 
051
052                        @Description(shortDefinition="Search for resources which have the given security labels")
053                        @OptionalParam(name=ca.uhn.fhir.rest.api.Constants.PARAM_SECURITY)
054                        TokenAndListParam theSearchForSecurity, 
055  
056                        @Description(shortDefinition="Search for resources which have the given profile")
057                        @OptionalParam(name=ca.uhn.fhir.rest.api.Constants.PARAM_PROFILE)
058                        UriAndListParam theSearchForProfile,
059
060                        @Description(shortDefinition="Search for resources which have the given source value (Resource.meta.source)")
061                        @OptionalParam(name=ca.uhn.fhir.rest.api.Constants.PARAM_SOURCE)
062                        UriAndListParam theSearchForSource,
063
064                        @Description(shortDefinition="Return resources linked to by the given target")
065                        @OptionalParam(name="_has")
066                        HasAndListParam theHas, 
067
068   
069
070                        @Description(shortDefinition="The ID of the resource")
071                        @OptionalParam(name="_id")
072                        TokenAndListParam the_id,
073   
074
075                        @Description(shortDefinition="Search on the narrative of the resource")
076                        @OptionalParam(name="_text")
077                        SpecialAndListParam the_text,
078   
079
080                        @Description(shortDefinition="Who attested the composition")
081                        @OptionalParam(name="attester", targetTypes={  } )
082                        ReferenceAndListParam theAttester, 
083   
084
085                        @Description(shortDefinition="Who and/or what authored the document")
086                        @OptionalParam(name="author", targetTypes={  } )
087                        ReferenceAndListParam theAuthor, 
088   
089
090                        @Description(shortDefinition="Procedure that caused this media to be created")
091                        @OptionalParam(name="based-on", targetTypes={  } )
092                        ReferenceAndListParam theBased_on, 
093   
094
095                        @Description(shortDefinition="Categorization of document")
096                        @OptionalParam(name="category")
097                        TokenAndListParam theCategory,
098   
099
100                        @Description(shortDefinition="Mime type of the content, with charset etc.")
101                        @OptionalParam(name="contenttype")
102                        TokenAndListParam theContenttype,
103   
104
105                        @Description(shortDefinition="Date attachment was first created")
106                        @OptionalParam(name="creation")
107                        DateRangeParam theCreation, 
108   
109
110                        @Description(shortDefinition="Organization which maintains the document")
111                        @OptionalParam(name="custodian", targetTypes={  } )
112                        ReferenceAndListParam theCustodian, 
113   
114
115                        @Description(shortDefinition="When this document reference was created")
116                        @OptionalParam(name="date")
117                        DateRangeParam theDate, 
118   
119
120                        @Description(shortDefinition="Human-readable description")
121                        @OptionalParam(name="description")
122                        StringAndListParam theDescription, 
123   
124
125                        @Description(shortDefinition="preliminary | final | amended | entered-in-error")
126                        @OptionalParam(name="doc-status")
127                        TokenAndListParam theDoc_status,
128   
129
130                        @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): The Encounter during which this Procedure was created* [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")
131                        @OptionalParam(name="encounter", targetTypes={  } )
132                        ReferenceAndListParam theEncounter, 
133   
134
135                        @Description(shortDefinition="Main clinical acts documented")
136                        @OptionalParam(name="event")
137                        TokenAndListParam theEvent,
138   
139
140                        @Description(shortDefinition="Kind of facility where patient was seen")
141                        @OptionalParam(name="facility")
142                        TokenAndListParam theFacility,
143   
144
145                        @Description(shortDefinition="Format/content rules for the document")
146                        @OptionalParam(name="format")
147                        TokenAndListParam theFormat,
148   
149
150                        @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): Identifier of the attachment binary* [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* [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* [MedicationUsage](medicationusage.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")
151                        @OptionalParam(name="identifier")
152                        TokenAndListParam theIdentifier,
153   
154
155                        @Description(shortDefinition="Human language of the content (BCP-47)")
156                        @OptionalParam(name="language")
157                        TokenAndListParam theLanguage,
158   
159
160                        @Description(shortDefinition="Uri where the data can be found")
161                        @OptionalParam(name="location")
162                        UriAndListParam theLocation, 
163   
164
165                        @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 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* [DeviceUsage](deviceusage.html): Search by patient who used / uses the device* [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 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* [MedicationUsage](medicationusage.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")
166                        @OptionalParam(name="patient", targetTypes={  } )
167                        ReferenceAndListParam thePatient, 
168   
169
170                        @Description(shortDefinition="Time of service that is being documented")
171                        @OptionalParam(name="period")
172                        DateRangeParam thePeriod, 
173   
174
175                        @Description(shortDefinition="Related identifiers or resources")
176                        @OptionalParam(name="related", targetTypes={  } )
177                        ReferenceAndListParam theRelated, 
178   
179
180                        @Description(shortDefinition="Target of the relationship")
181                        @OptionalParam(name="relatesto", targetTypes={  } )
182                        ReferenceAndListParam theRelatesto, 
183   
184
185                        @Description(shortDefinition="replaces | transforms | signs | appends")
186                        @OptionalParam(name="relation")
187                        TokenAndListParam theRelation,
188   
189
190                        @Description(shortDefinition="Combination of relation and relatesTo")
191                        @OptionalParam(name="relationship", compositeTypes= { ReferenceParam.class, TokenParam.class })
192                        CompositeAndListParam<ReferenceParam, TokenParam> theRelationship,
193   
194
195                        @Description(shortDefinition="Document security-tags")
196                        @OptionalParam(name="security-label")
197                        TokenAndListParam theSecurity_label,
198   
199
200                        @Description(shortDefinition="Additional details about where the content was created (e.g. clinical specialty)")
201                        @OptionalParam(name="setting")
202                        TokenAndListParam theSetting,
203   
204
205                        @Description(shortDefinition="current | superseded | entered-in-error")
206                        @OptionalParam(name="status")
207                        TokenAndListParam theStatus,
208   
209
210                        @Description(shortDefinition="Who/what is the subject of the document")
211                        @OptionalParam(name="subject", targetTypes={  } )
212                        ReferenceAndListParam theSubject, 
213   
214
215                        @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")
216                        @OptionalParam(name="type")
217                        TokenAndListParam theType,
218
219                        @RawParam
220                        Map<String, List<String>> theAdditionalRawParams,
221
222                        @Description(shortDefinition="Only return resources which were last updated as specified by the given range")
223                        @OptionalParam(name="_lastUpdated")
224                        DateRangeParam theLastUpdated, 
225
226                        @IncludeParam
227                        Set<Include> theIncludes,
228
229                        @IncludeParam(reverse=true)
230                        Set<Include> theRevIncludes,
231
232                        @Sort
233                        SortSpec theSort,
234                        
235                        @ca.uhn.fhir.rest.annotation.Count
236                        Integer theCount,
237
238                        @ca.uhn.fhir.rest.annotation.Offset
239                        Integer theOffset,
240
241                        SummaryEnum theSummaryMode,
242
243                        SearchTotalModeEnum theSearchTotalMode,
244
245                        SearchContainedModeEnum theSearchContainedMode
246
247                        ) {
248                startRequest(theServletRequest);
249                try {
250                        SearchParameterMap paramMap = new SearchParameterMap();
251                        paramMap.add(ca.uhn.fhir.rest.api.Constants.PARAM_FILTER, theFtFilter);
252                        paramMap.add(ca.uhn.fhir.rest.api.Constants.PARAM_CONTENT, theFtContent);
253                        paramMap.add(ca.uhn.fhir.rest.api.Constants.PARAM_TEXT, theFtText);
254                        paramMap.add(ca.uhn.fhir.rest.api.Constants.PARAM_TAG, theSearchForTag);
255                        paramMap.add(ca.uhn.fhir.rest.api.Constants.PARAM_SECURITY, theSearchForSecurity);
256                        paramMap.add(ca.uhn.fhir.rest.api.Constants.PARAM_PROFILE, theSearchForProfile);
257                        paramMap.add(ca.uhn.fhir.rest.api.Constants.PARAM_SOURCE, theSearchForSource);
258                        paramMap.add("_has", theHas);
259                        paramMap.add("_id", the_id);
260                        paramMap.add("_text", the_text);
261                        paramMap.add("attester", theAttester);
262                        paramMap.add("author", theAuthor);
263                        paramMap.add("based-on", theBased_on);
264                        paramMap.add("category", theCategory);
265                        paramMap.add("contenttype", theContenttype);
266                        paramMap.add("creation", theCreation);
267                        paramMap.add("custodian", theCustodian);
268                        paramMap.add("date", theDate);
269                        paramMap.add("description", theDescription);
270                        paramMap.add("doc-status", theDoc_status);
271                        paramMap.add("encounter", theEncounter);
272                        paramMap.add("event", theEvent);
273                        paramMap.add("facility", theFacility);
274                        paramMap.add("format", theFormat);
275                        paramMap.add("identifier", theIdentifier);
276                        paramMap.add("language", theLanguage);
277                        paramMap.add("location", theLocation);
278                        paramMap.add("patient", thePatient);
279                        paramMap.add("period", thePeriod);
280                        paramMap.add("related", theRelated);
281                        paramMap.add("relatesto", theRelatesto);
282                        paramMap.add("relation", theRelation);
283                        paramMap.add("relationship", theRelationship);
284                        paramMap.add("security-label", theSecurity_label);
285                        paramMap.add("setting", theSetting);
286                        paramMap.add("status", theStatus);
287                        paramMap.add("subject", theSubject);
288                        paramMap.add("type", theType);
289                        paramMap.setRevIncludes(theRevIncludes);
290                        paramMap.setLastUpdated(theLastUpdated);
291                        paramMap.setIncludes(theIncludes);
292                        paramMap.setSort(theSort);
293                        paramMap.setCount(theCount);
294                        paramMap.setOffset(theOffset);
295                        paramMap.setSummaryMode(theSummaryMode);
296                        paramMap.setSearchTotalMode(theSearchTotalMode);
297                        paramMap.setSearchContainedMode(theSearchContainedMode);
298
299                        getDao().translateRawParameters(theAdditionalRawParams, paramMap);
300
301                        ca.uhn.fhir.rest.api.server.IBundleProvider retVal = getDao().search(paramMap, theRequestDetails, theServletResponse);
302                        return retVal;
303                } finally {
304                        endRequest(theServletRequest);
305                }
306        }
307
308}