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 ObservationResourceProvider extends 020 ca.uhn.fhir.jpa.provider.BaseJpaResourceProviderObservation<Observation> 021 { 022 023 @Override 024 public Class<Observation> getResourceType() { 025 return Observation.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="HGVS Protein Change") 097 @OptionalParam(name="amino-acid-change") 098 StringAndListParam theAmino_acid_change, 099 100 101 @Description(shortDefinition="Reference to the service request.") 102 @OptionalParam(name="based-on", targetTypes={ } ) 103 ReferenceAndListParam theBased_on, 104 105 106 @Description(shortDefinition="The classification of the type of observation") 107 @OptionalParam(name="category") 108 TokenAndListParam theCategory, 109 110 111 @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* [MedicationStatement](medicationstatement.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") 112 @OptionalParam(name="code") 113 TokenAndListParam theCode, 114 115 116 @Description(shortDefinition="Code and coded value parameter pair") 117 @OptionalParam(name="code-value-concept", compositeTypes= { TokenParam.class, TokenParam.class }) 118 CompositeAndListParam<TokenParam, TokenParam> theCode_value_concept, 119 120 121 @Description(shortDefinition="Code and date/time value parameter pair") 122 @OptionalParam(name="code-value-date", compositeTypes= { TokenParam.class, DateParam.class }) 123 CompositeAndListParam<TokenParam, DateParam> theCode_value_date, 124 125 126 @Description(shortDefinition="Code and quantity value parameter pair") 127 @OptionalParam(name="code-value-quantity", compositeTypes= { TokenParam.class, QuantityParam.class }) 128 CompositeAndListParam<TokenParam, QuantityParam> theCode_value_quantity, 129 130 131 @Description(shortDefinition="Code and string value parameter pair") 132 @OptionalParam(name="code-value-string", compositeTypes= { TokenParam.class, StringParam.class }) 133 CompositeAndListParam<TokenParam, StringParam> theCode_value_string, 134 135 136 @Description(shortDefinition="The code of the observation type or component type") 137 @OptionalParam(name="combo-code") 138 TokenAndListParam theCombo_code, 139 140 141 @Description(shortDefinition="Code and coded value parameter pair, including in components") 142 @OptionalParam(name="combo-code-value-concept", compositeTypes= { TokenParam.class, TokenParam.class }) 143 CompositeAndListParam<TokenParam, TokenParam> theCombo_code_value_concept, 144 145 146 @Description(shortDefinition="Code and quantity value parameter pair, including in components") 147 @OptionalParam(name="combo-code-value-quantity", compositeTypes= { TokenParam.class, QuantityParam.class }) 148 CompositeAndListParam<TokenParam, QuantityParam> theCombo_code_value_quantity, 149 150 151 @Description(shortDefinition="The reason why the expected value in the element Observation.value[x] or Observation.component.value[x] is missing.") 152 @OptionalParam(name="combo-data-absent-reason") 153 TokenAndListParam theCombo_data_absent_reason, 154 155 156 @Description(shortDefinition="The value or component value of the observation, if the value is a CodeableConcept") 157 @OptionalParam(name="combo-value-concept") 158 TokenAndListParam theCombo_value_concept, 159 160 161 @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)") 162 @OptionalParam(name="combo-value-quantity") 163 QuantityAndListParam theCombo_value_quantity, 164 165 166 @Description(shortDefinition="The component code of the observation type") 167 @OptionalParam(name="component-code") 168 TokenAndListParam theComponent_code, 169 170 171 @Description(shortDefinition="Component code and component coded value parameter pair") 172 @OptionalParam(name="component-code-value-concept", compositeTypes= { TokenParam.class, TokenParam.class }) 173 CompositeAndListParam<TokenParam, TokenParam> theComponent_code_value_concept, 174 175 176 @Description(shortDefinition="Component code and component quantity value parameter pair") 177 @OptionalParam(name="component-code-value-quantity", compositeTypes= { TokenParam.class, QuantityParam.class }) 178 CompositeAndListParam<TokenParam, QuantityParam> theComponent_code_value_quantity, 179 180 181 @Description(shortDefinition="The reason why the expected value in the element Observation.component.value[x] is missing.") 182 @OptionalParam(name="component-data-absent-reason") 183 TokenAndListParam theComponent_data_absent_reason, 184 185 186 @Description(shortDefinition="The value of the component observation, if the value is a CodeableConcept") 187 @OptionalParam(name="component-value-concept") 188 TokenAndListParam theComponent_value_concept, 189 190 191 @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)") 192 @OptionalParam(name="component-value-quantity") 193 QuantityAndListParam theComponent_value_quantity, 194 195 196 @Description(shortDefinition="The reason why the expected value in the element Observation.value[x] is missing.") 197 @OptionalParam(name="data-absent-reason") 198 TokenAndListParam theData_absent_reason, 199 200 201 @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): Time period team covers* [ClinicalImpression](clinicalimpression.html): When the assessment was documented* [Composition](composition.html): Composition editing time* [Consent](consent.html): When this Consent was created or indexed* [DiagnosticReport](diagnosticreport.html): The clinically relevant time of the report* [Encounter](encounter.html): A date within the period 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 was performed* [RiskAssessment](riskassessment.html): When was assessment made?* [SupplyRequest](supplyrequest.html): When the request was made") 202 @OptionalParam(name="date") 203 DateRangeParam theDate, 204 205 206 @Description(shortDefinition="Related measurements the observation is made from") 207 @OptionalParam(name="derived-from", targetTypes={ } ) 208 ReferenceAndListParam theDerived_from, 209 210 211 @Description(shortDefinition="The Device that generated the observation data.") 212 @OptionalParam(name="device", targetTypes={ } ) 213 ReferenceAndListParam theDevice, 214 215 216 @Description(shortDefinition="HGVS DNA variant") 217 @OptionalParam(name="dna-variant") 218 StringAndListParam theDna_variant, 219 220 221 @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") 222 @OptionalParam(name="encounter", targetTypes={ } ) 223 ReferenceAndListParam theEncounter, 224 225 226 @Description(shortDefinition="The focus of an observation when the focus is not the patient of record.") 227 @OptionalParam(name="focus", targetTypes={ } ) 228 ReferenceAndListParam theFocus, 229 230 231 @Description(shortDefinition="HGNC gene symbol and HGVS Protein change") 232 @OptionalParam(name="gene-amino-acid-change") 233 StringAndListParam theGene_amino_acid_change, 234 235 236 @Description(shortDefinition="HGNC gene symbol and HGVS DNA Variant") 237 @OptionalParam(name="gene-dnavariant") 238 StringAndListParam theGene_dnavariant, 239 240 241 @Description(shortDefinition="HGNC gene symbol and identifier") 242 @OptionalParam(name="gene-identifier") 243 TokenAndListParam theGene_identifier, 244 245 246 @Description(shortDefinition="Related resource that belongs to the Observation group") 247 @OptionalParam(name="has-member", targetTypes={ } ) 248 ReferenceAndListParam theHas_member, 249 250 251 @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") 252 @OptionalParam(name="identifier") 253 TokenAndListParam theIdentifier, 254 255 256 @Description(shortDefinition="The method used for the observation") 257 @OptionalParam(name="method") 258 TokenAndListParam theMethod, 259 260 261 @Description(shortDefinition="Part of referenced event") 262 @OptionalParam(name="part-of", targetTypes={ } ) 263 ReferenceAndListParam thePart_of, 264 265 266 @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") 267 @OptionalParam(name="patient", targetTypes={ } ) 268 ReferenceAndListParam thePatient, 269 270 271 @Description(shortDefinition="Who performed the observation") 272 @OptionalParam(name="performer", targetTypes={ } ) 273 ReferenceAndListParam thePerformer, 274 275 276 @Description(shortDefinition="Specimen used for this observation") 277 @OptionalParam(name="specimen", targetTypes={ } ) 278 ReferenceAndListParam theSpecimen, 279 280 281 @Description(shortDefinition="The status of the observation") 282 @OptionalParam(name="status") 283 TokenAndListParam theStatus, 284 285 286 @Description(shortDefinition="The subject that the observation is about") 287 @OptionalParam(name="subject", targetTypes={ } ) 288 ReferenceAndListParam theSubject, 289 290 291 @Description(shortDefinition="The value of the observation, if the value is a CodeableConcept") 292 @OptionalParam(name="value-concept") 293 TokenAndListParam theValue_concept, 294 295 296 @Description(shortDefinition="The value of the observation, if the value is a date or period of time") 297 @OptionalParam(name="value-date") 298 DateRangeParam theValue_date, 299 300 301 @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)") 302 @OptionalParam(name="value-quantity") 303 QuantityAndListParam theValue_quantity, 304 305 306 @Description(shortDefinition="The value of the observation, if the value is a string, and also searches in CodeableConcept.text") 307 @OptionalParam(name="value-string") 308 StringAndListParam theValue_string, 309 310 @RawParam 311 Map<String, List<String>> theAdditionalRawParams, 312 313 314 @IncludeParam 315 Set<Include> theIncludes, 316 317 @IncludeParam(reverse=true) 318 Set<Include> theRevIncludes, 319 320 @Sort 321 SortSpec theSort, 322 323 @ca.uhn.fhir.rest.annotation.Count 324 Integer theCount, 325 326 @ca.uhn.fhir.rest.annotation.Offset 327 Integer theOffset, 328 329 SummaryEnum theSummaryMode, 330 331 SearchTotalModeEnum theSearchTotalMode, 332 333 SearchContainedModeEnum theSearchContainedMode 334 335 ) { 336 startRequest(theServletRequest); 337 try { 338 SearchParameterMap paramMap = new SearchParameterMap(); 339 paramMap.add(ca.uhn.fhir.rest.api.Constants.PARAM_FILTER, theFtFilter); 340 paramMap.add(ca.uhn.fhir.rest.api.Constants.PARAM_CONTENT, theFtContent); 341 paramMap.add(ca.uhn.fhir.rest.api.Constants.PARAM_TEXT, theFtText); 342 paramMap.add(ca.uhn.fhir.rest.api.Constants.PARAM_SOURCE, theSearchForSource); 343 paramMap.add(ca.uhn.fhir.rest.api.Constants.PARAM_LIST, theList); 344 paramMap.add(ca.uhn.fhir.rest.api.Constants.PARAM_LANGUAGE, theResourceLanguage); 345 346 paramMap.add("_has", theHas); 347 paramMap.add("_id", the_id); 348 paramMap.add("_profile", the_profile); 349 paramMap.add("_security", the_security); 350 paramMap.add("_tag", the_tag); 351 paramMap.add("_text", the_text); 352 paramMap.add("amino-acid-change", theAmino_acid_change); 353 paramMap.add("based-on", theBased_on); 354 paramMap.add("category", theCategory); 355 paramMap.add("code", theCode); 356 paramMap.add("code-value-concept", theCode_value_concept); 357 paramMap.add("code-value-date", theCode_value_date); 358 paramMap.add("code-value-quantity", theCode_value_quantity); 359 paramMap.add("code-value-string", theCode_value_string); 360 paramMap.add("combo-code", theCombo_code); 361 paramMap.add("combo-code-value-concept", theCombo_code_value_concept); 362 paramMap.add("combo-code-value-quantity", theCombo_code_value_quantity); 363 paramMap.add("combo-data-absent-reason", theCombo_data_absent_reason); 364 paramMap.add("combo-value-concept", theCombo_value_concept); 365 paramMap.add("combo-value-quantity", theCombo_value_quantity); 366 paramMap.add("component-code", theComponent_code); 367 paramMap.add("component-code-value-concept", theComponent_code_value_concept); 368 paramMap.add("component-code-value-quantity", theComponent_code_value_quantity); 369 paramMap.add("component-data-absent-reason", theComponent_data_absent_reason); 370 paramMap.add("component-value-concept", theComponent_value_concept); 371 paramMap.add("component-value-quantity", theComponent_value_quantity); 372 paramMap.add("data-absent-reason", theData_absent_reason); 373 paramMap.add("date", theDate); 374 paramMap.add("derived-from", theDerived_from); 375 paramMap.add("device", theDevice); 376 paramMap.add("dna-variant", theDna_variant); 377 paramMap.add("encounter", theEncounter); 378 paramMap.add("focus", theFocus); 379 paramMap.add("gene-amino-acid-change", theGene_amino_acid_change); 380 paramMap.add("gene-dnavariant", theGene_dnavariant); 381 paramMap.add("gene-identifier", theGene_identifier); 382 paramMap.add("has-member", theHas_member); 383 paramMap.add("identifier", theIdentifier); 384 paramMap.add("method", theMethod); 385 paramMap.add("part-of", thePart_of); 386 paramMap.add("patient", thePatient); 387 paramMap.add("performer", thePerformer); 388 paramMap.add("specimen", theSpecimen); 389 paramMap.add("status", theStatus); 390 paramMap.add("subject", theSubject); 391 paramMap.add("value-concept", theValue_concept); 392 paramMap.add("value-date", theValue_date); 393 paramMap.add("value-quantity", theValue_quantity); 394 paramMap.add("value-string", theValue_string); 395paramMap.setRevIncludes(theRevIncludes); 396 paramMap.setLastUpdated(the_lastUpdated); 397 paramMap.setIncludes(theIncludes); 398 paramMap.setSort(theSort); 399 paramMap.setCount(theCount); 400 paramMap.setOffset(theOffset); 401 paramMap.setSummaryMode(theSummaryMode); 402 paramMap.setSearchTotalMode(theSearchTotalMode); 403 paramMap.setSearchContainedMode(theSearchContainedMode); 404 405 getDao().translateRawParameters(theAdditionalRawParams, paramMap); 406 407 ca.uhn.fhir.rest.api.server.IBundleProvider retVal = getDao().search(paramMap, theRequestDetails, theServletResponse); 408 return retVal; 409 } finally { 410 endRequest(theServletRequest); 411 } 412 } 413 414}