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