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 ObservationResourceProvider extends 
021        BaseJpaResourceProviderObservationR5
022        {
023
024        @Override
025        public Class<Observation> getResourceType() {
026                return Observation.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="Reference to the service request.")
081                        @OptionalParam(name="based-on", targetTypes={  } )
082                        ReferenceAndListParam theBased_on, 
083   
084
085                        @Description(shortDefinition="The classification of the type of observation")
086                        @OptionalParam(name="category")
087                        TokenAndListParam theCategory,
088   
089
090                        @Description(shortDefinition="Multiple Resources: * [AllergyIntolerance](allergyintolerance.html): Code that identifies the allergy or intolerance* [Condition](condition.html): Code for the condition* [DeviceRequest](devicerequest.html): Code for what is being requested/ordered* [DiagnosticReport](diagnosticreport.html): The code for the report, as opposed to codes for the atomic results, which are the names on the observation resource referred to from the result* [FamilyMemberHistory](familymemberhistory.html): A search by a condition code* [List](list.html): What the purpose of this list is* [Medication](medication.html): Returns medications for a specific code* [MedicationAdministration](medicationadministration.html): Return administrations of this medication code* [MedicationDispense](medicationdispense.html): Returns dispenses of this medicine code* [MedicationRequest](medicationrequest.html): Return prescriptions of this medication code* [MedicationUsage](medicationusage.html): Return statements of this medication code* [Observation](observation.html): The code of the observation type* [Procedure](procedure.html): A code to identify a  procedure* [ServiceRequest](servicerequest.html): What is being requested/ordered")
091                        @OptionalParam(name="code")
092                        TokenAndListParam theCode,
093   
094
095                        @Description(shortDefinition="Code and coded value parameter pair")
096                        @OptionalParam(name="code-value-concept", compositeTypes= { TokenParam.class, TokenParam.class })
097                        CompositeAndListParam<TokenParam, TokenParam> theCode_value_concept,
098   
099
100                        @Description(shortDefinition="Code and date/time value parameter pair")
101                        @OptionalParam(name="code-value-date", compositeTypes= { TokenParam.class, DateParam.class })
102                        CompositeAndListParam<TokenParam, DateParam> theCode_value_date,
103   
104
105                        @Description(shortDefinition="Code and quantity value parameter pair")
106                        @OptionalParam(name="code-value-quantity", compositeTypes= { TokenParam.class, QuantityParam.class })
107                        CompositeAndListParam<TokenParam, QuantityParam> theCode_value_quantity,
108   
109
110                        @Description(shortDefinition="Code and string value parameter pair")
111                        @OptionalParam(name="code-value-string", compositeTypes= { TokenParam.class, StringParam.class })
112                        CompositeAndListParam<TokenParam, StringParam> theCode_value_string,
113   
114
115                        @Description(shortDefinition="The code of the observation type or component type")
116                        @OptionalParam(name="combo-code")
117                        TokenAndListParam theCombo_code,
118   
119
120                        @Description(shortDefinition="Code and coded value parameter pair, including in components")
121                        @OptionalParam(name="combo-code-value-concept", compositeTypes= { TokenParam.class, TokenParam.class })
122                        CompositeAndListParam<TokenParam, TokenParam> theCombo_code_value_concept,
123   
124
125                        @Description(shortDefinition="Code and quantity value parameter pair, including in components")
126                        @OptionalParam(name="combo-code-value-quantity", compositeTypes= { TokenParam.class, QuantityParam.class })
127                        CompositeAndListParam<TokenParam, QuantityParam> theCombo_code_value_quantity,
128   
129
130                        @Description(shortDefinition="The reason why the expected value in the element Observation.value[x] or Observation.component.value[x] is missing.")
131                        @OptionalParam(name="combo-data-absent-reason")
132                        TokenAndListParam theCombo_data_absent_reason,
133   
134
135                        @Description(shortDefinition="The value or component value of the observation, if the value is a CodeableConcept")
136                        @OptionalParam(name="combo-value-concept")
137                        TokenAndListParam theCombo_value_concept,
138   
139
140                        @Description(shortDefinition="The value or component value of the observation, if the value is a Quantity, or a SampledData (just search on the bounds of the values in sampled data)")
141                        @OptionalParam(name="combo-value-quantity")
142                        QuantityAndListParam theCombo_value_quantity, 
143   
144
145                        @Description(shortDefinition="The component code of the observation type")
146                        @OptionalParam(name="component-code")
147                        TokenAndListParam theComponent_code,
148   
149
150                        @Description(shortDefinition="Component code and component coded value parameter pair")
151                        @OptionalParam(name="component-code-value-concept", compositeTypes= { TokenParam.class, TokenParam.class })
152                        CompositeAndListParam<TokenParam, TokenParam> theComponent_code_value_concept,
153   
154
155                        @Description(shortDefinition="Component code and component quantity value parameter pair")
156                        @OptionalParam(name="component-code-value-quantity", compositeTypes= { TokenParam.class, QuantityParam.class })
157                        CompositeAndListParam<TokenParam, QuantityParam> theComponent_code_value_quantity,
158   
159
160                        @Description(shortDefinition="The reason why the expected value in the element Observation.component.value[x] is missing.")
161                        @OptionalParam(name="component-data-absent-reason")
162                        TokenAndListParam theComponent_data_absent_reason,
163   
164
165                        @Description(shortDefinition="The value of the component observation, if the value is a CodeableConcept")
166                        @OptionalParam(name="component-value-concept")
167                        TokenAndListParam theComponent_value_concept,
168   
169
170                        @Description(shortDefinition="The value of the component observation, if the value is a Quantity, or a SampledData (just search on the bounds of the values in sampled data)")
171                        @OptionalParam(name="component-value-quantity")
172                        QuantityAndListParam theComponent_value_quantity, 
173   
174
175                        @Description(shortDefinition="The reason why the expected value in the element Observation.value[x] is missing.")
176                        @OptionalParam(name="data-absent-reason")
177                        TokenAndListParam theData_absent_reason,
178   
179
180                        @Description(shortDefinition="Multiple Resources: * [AllergyIntolerance](allergyintolerance.html): Date first version of the resource instance was recorded* [CarePlan](careplan.html): Time period plan covers* [CareTeam](careteam.html): A date within the coverage time period.* [ClinicalImpression](clinicalimpression.html): When the assessment was documented* [Composition](composition.html): Composition editing time* [Consent](consent.html): When consent was agreed to* [DiagnosticReport](diagnosticreport.html): The clinically relevant time of the report* [Encounter](encounter.html): A date within the actualPeriod the Encounter lasted* [EpisodeOfCare](episodeofcare.html): The provided date search value falls within the episode of care's period* [FamilyMemberHistory](familymemberhistory.html): When history was recorded or last updated* [Flag](flag.html): Time period when flag is active* [Immunization](immunization.html): Vaccination  (non)-Administration Date* [List](list.html): When the list was prepared* [Observation](observation.html): Obtained date/time. If the obtained element is a period, a date that falls in the period* [Procedure](procedure.html): When the procedure occurred or is occurring* [RiskAssessment](riskassessment.html): When was assessment made?* [SupplyRequest](supplyrequest.html): When the request was made")
181                        @OptionalParam(name="date")
182                        DateRangeParam theDate, 
183   
184
185                        @Description(shortDefinition="Related measurements the observation is made from")
186                        @OptionalParam(name="derived-from", targetTypes={  } )
187                        ReferenceAndListParam theDerived_from, 
188   
189
190                        @Description(shortDefinition="The Device that generated the observation data.")
191                        @OptionalParam(name="device", targetTypes={  } )
192                        ReferenceAndListParam theDevice, 
193   
194
195                        @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")
196                        @OptionalParam(name="encounter", targetTypes={  } )
197                        ReferenceAndListParam theEncounter, 
198   
199
200                        @Description(shortDefinition="The focus of an observation when the focus is not the patient of record.")
201                        @OptionalParam(name="focus", targetTypes={  } )
202                        ReferenceAndListParam theFocus, 
203   
204
205                        @Description(shortDefinition="Related resource that belongs to the Observation group")
206                        @OptionalParam(name="has-member", targetTypes={  } )
207                        ReferenceAndListParam theHas_member, 
208   
209
210                        @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")
211                        @OptionalParam(name="identifier")
212                        TokenAndListParam theIdentifier,
213   
214
215                        @Description(shortDefinition="The method used for the observation")
216                        @OptionalParam(name="method")
217                        TokenAndListParam theMethod,
218   
219
220                        @Description(shortDefinition="Part of referenced event")
221                        @OptionalParam(name="part-of", targetTypes={  } )
222                        ReferenceAndListParam thePart_of, 
223   
224
225                        @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")
226                        @OptionalParam(name="patient", targetTypes={  } )
227                        ReferenceAndListParam thePatient, 
228   
229
230                        @Description(shortDefinition="Who performed the observation")
231                        @OptionalParam(name="performer", targetTypes={  } )
232                        ReferenceAndListParam thePerformer, 
233   
234
235                        @Description(shortDefinition="Specimen used for this observation")
236                        @OptionalParam(name="specimen", targetTypes={  } )
237                        ReferenceAndListParam theSpecimen, 
238   
239
240                        @Description(shortDefinition="The status of the observation")
241                        @OptionalParam(name="status")
242                        TokenAndListParam theStatus,
243   
244
245                        @Description(shortDefinition="The subject that the observation is about")
246                        @OptionalParam(name="subject", targetTypes={  } )
247                        ReferenceAndListParam theSubject, 
248   
249
250                        @Description(shortDefinition="The value of the observation, if the value is a CodeableConcept")
251                        @OptionalParam(name="value-concept")
252                        TokenAndListParam theValue_concept,
253   
254
255                        @Description(shortDefinition="The value of the observation, if the value is a date or period of time")
256                        @OptionalParam(name="value-date")
257                        DateRangeParam theValue_date, 
258   
259
260                        @Description(shortDefinition="The value of the observation, if the value is a Quantity, or a SampledData (just search on the bounds of the values in sampled data)")
261                        @OptionalParam(name="value-quantity")
262                        QuantityAndListParam theValue_quantity, 
263   
264
265                        @Description(shortDefinition="The value of the observation, if the value is a string, and also searches in CodeableConcept.text")
266                        @OptionalParam(name="value-string")
267                        StringAndListParam theValue_string, 
268
269                        @RawParam
270                        Map<String, List<String>> theAdditionalRawParams,
271
272                        @Description(shortDefinition="Only return resources which were last updated as specified by the given range")
273                        @OptionalParam(name="_lastUpdated")
274                        DateRangeParam theLastUpdated, 
275
276                        @IncludeParam
277                        Set<Include> theIncludes,
278
279                        @IncludeParam(reverse=true)
280                        Set<Include> theRevIncludes,
281
282                        @Sort
283                        SortSpec theSort,
284                        
285                        @ca.uhn.fhir.rest.annotation.Count
286                        Integer theCount,
287
288                        @ca.uhn.fhir.rest.annotation.Offset
289                        Integer theOffset,
290
291                        SummaryEnum theSummaryMode,
292
293                        SearchTotalModeEnum theSearchTotalMode,
294
295                        SearchContainedModeEnum theSearchContainedMode
296
297                        ) {
298                startRequest(theServletRequest);
299                try {
300                        SearchParameterMap paramMap = new SearchParameterMap();
301                        paramMap.add(ca.uhn.fhir.rest.api.Constants.PARAM_FILTER, theFtFilter);
302                        paramMap.add(ca.uhn.fhir.rest.api.Constants.PARAM_CONTENT, theFtContent);
303                        paramMap.add(ca.uhn.fhir.rest.api.Constants.PARAM_TEXT, theFtText);
304                        paramMap.add(ca.uhn.fhir.rest.api.Constants.PARAM_TAG, theSearchForTag);
305                        paramMap.add(ca.uhn.fhir.rest.api.Constants.PARAM_SECURITY, theSearchForSecurity);
306                        paramMap.add(ca.uhn.fhir.rest.api.Constants.PARAM_PROFILE, theSearchForProfile);
307                        paramMap.add(ca.uhn.fhir.rest.api.Constants.PARAM_SOURCE, theSearchForSource);
308                        paramMap.add("_has", theHas);
309                        paramMap.add("_id", the_id);
310                        paramMap.add("_text", the_text);
311                        paramMap.add("based-on", theBased_on);
312                        paramMap.add("category", theCategory);
313                        paramMap.add("code", theCode);
314                        paramMap.add("code-value-concept", theCode_value_concept);
315                        paramMap.add("code-value-date", theCode_value_date);
316                        paramMap.add("code-value-quantity", theCode_value_quantity);
317                        paramMap.add("code-value-string", theCode_value_string);
318                        paramMap.add("combo-code", theCombo_code);
319                        paramMap.add("combo-code-value-concept", theCombo_code_value_concept);
320                        paramMap.add("combo-code-value-quantity", theCombo_code_value_quantity);
321                        paramMap.add("combo-data-absent-reason", theCombo_data_absent_reason);
322                        paramMap.add("combo-value-concept", theCombo_value_concept);
323                        paramMap.add("combo-value-quantity", theCombo_value_quantity);
324                        paramMap.add("component-code", theComponent_code);
325                        paramMap.add("component-code-value-concept", theComponent_code_value_concept);
326                        paramMap.add("component-code-value-quantity", theComponent_code_value_quantity);
327                        paramMap.add("component-data-absent-reason", theComponent_data_absent_reason);
328                        paramMap.add("component-value-concept", theComponent_value_concept);
329                        paramMap.add("component-value-quantity", theComponent_value_quantity);
330                        paramMap.add("data-absent-reason", theData_absent_reason);
331                        paramMap.add("date", theDate);
332                        paramMap.add("derived-from", theDerived_from);
333                        paramMap.add("device", theDevice);
334                        paramMap.add("encounter", theEncounter);
335                        paramMap.add("focus", theFocus);
336                        paramMap.add("has-member", theHas_member);
337                        paramMap.add("identifier", theIdentifier);
338                        paramMap.add("method", theMethod);
339                        paramMap.add("part-of", thePart_of);
340                        paramMap.add("patient", thePatient);
341                        paramMap.add("performer", thePerformer);
342                        paramMap.add("specimen", theSpecimen);
343                        paramMap.add("status", theStatus);
344                        paramMap.add("subject", theSubject);
345                        paramMap.add("value-concept", theValue_concept);
346                        paramMap.add("value-date", theValue_date);
347                        paramMap.add("value-quantity", theValue_quantity);
348                        paramMap.add("value-string", theValue_string);
349                        paramMap.setRevIncludes(theRevIncludes);
350                        paramMap.setLastUpdated(theLastUpdated);
351                        paramMap.setIncludes(theIncludes);
352                        paramMap.setSort(theSort);
353                        paramMap.setCount(theCount);
354                        paramMap.setOffset(theOffset);
355                        paramMap.setSummaryMode(theSummaryMode);
356                        paramMap.setSearchTotalMode(theSearchTotalMode);
357                        paramMap.setSearchContainedMode(theSearchContainedMode);
358
359                        getDao().translateRawParameters(theAdditionalRawParams, paramMap);
360
361                        ca.uhn.fhir.rest.api.server.IBundleProvider retVal = getDao().search(paramMap, theRequestDetails, theServletResponse);
362                        return retVal;
363                } finally {
364                        endRequest(theServletRequest);
365                }
366        }
367
368}