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