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.searchparam.SearchParameterMap;
009import ca.uhn.fhir.model.api.Include;
010import ca.uhn.fhir.model.api.annotation.*;
011import org.hl7.fhir.r5.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 ProvenanceResourceProvider extends 
020        ca.uhn.fhir.jpa.provider.BaseJpaResourceProvider<Provenance>
021        {
022
023        @Override
024        public Class<Provenance> getResourceType() {
025                return Provenance.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                        SpecialAndListParam the_text,
077   
078
079                        @Description(shortDefinition="Activity that occurred")
080                        @OptionalParam(name="activity")
081                        TokenAndListParam theActivity,
082   
083
084                        @Description(shortDefinition="Who participated")
085                        @OptionalParam(name="agent", targetTypes={  } )
086                        ReferenceAndListParam theAgent, 
087   
088
089                        @Description(shortDefinition="What the agents role was")
090                        @OptionalParam(name="agent-role")
091                        TokenAndListParam theAgent_role,
092   
093
094                        @Description(shortDefinition="How the agent participated")
095                        @OptionalParam(name="agent-type")
096                        TokenAndListParam theAgent_type,
097   
098
099                        @Description(shortDefinition="Reference to the service request.")
100                        @OptionalParam(name="based-on", targetTypes={  } )
101                        ReferenceAndListParam theBased_on, 
102   
103
104                        @Description(shortDefinition="Multiple Resources: * [AuditEvent](auditevent.html): Encounter related to the activity recorded in the AuditEvent* [CarePlan](careplan.html): The Encounter during which this CarePlan was created* [ChargeItem](chargeitem.html): Encounter associated with event* [Claim](claim.html): Encounters associated with a billed line item* [ClinicalImpression](clinicalimpression.html): The Encounter during which this ClinicalImpression was created* [Communication](communication.html): The Encounter during which this Communication was created* [CommunicationRequest](communicationrequest.html): The Encounter during which this CommunicationRequest was created* [Composition](composition.html): Context of the Composition* [Condition](condition.html): The Encounter during which this Condition was created* [DeviceRequest](devicerequest.html): Encounter during which request was created* [DiagnosticReport](diagnosticreport.html): The Encounter when the order was made* [EncounterHistory](encounterhistory.html): The Encounter associated with this set of history values* [ExplanationOfBenefit](explanationofbenefit.html): Encounters associated with a billed line item* [Flag](flag.html): Alert relevant during encounter* [ImagingStudy](imagingstudy.html): The context of the study* [List](list.html): Context in which list created* [MedicationDispense](medicationdispense.html): Returns dispenses with a specific encounter* [MedicationStatement](medicationstatement.html): Returns statements for a specific encounter* [NutritionIntake](nutritionintake.html): Returns statements for a specific encounter* [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* [Provenance](provenance.html): Encounter related to the Provenance* [QuestionnaireResponse](questionnaireresponse.html): Encounter associated with the questionnaire response* [RequestOrchestration](requestorchestration.html): The encounter the request orchestration applies to* [RiskAssessment](riskassessment.html): Where was assessment performed?* [ServiceRequest](servicerequest.html): An encounter in which this request is made* [Task](task.html): Search by encounter* [VisionPrescription](visionprescription.html): Return prescriptions with this encounter identifier")
105                        @OptionalParam(name="encounter", targetTypes={  } )
106                        ReferenceAndListParam theEncounter, 
107   
108
109                        @Description(shortDefinition="Identity of entity")
110                        @OptionalParam(name="entity", targetTypes={  } )
111                        ReferenceAndListParam theEntity, 
112   
113
114                        @Description(shortDefinition="Where the activity occurred, if relevant")
115                        @OptionalParam(name="location", targetTypes={  } )
116                        ReferenceAndListParam theLocation, 
117   
118
119                        @Description(shortDefinition="Multiple Resources: * [Account](account.html): The entity that caused the expenses* [AdverseEvent](adverseevent.html): Subject impacted by event* [AllergyIntolerance](allergyintolerance.html): Who the sensitivity is for* [Appointment](appointment.html): One of the individuals of the appointment is this patient* [AppointmentResponse](appointmentresponse.html): This Response is for this Patient* [AuditEvent](auditevent.html): Where the activity involved patient data* [Basic](basic.html): Identifies the focus of this resource* [BodyStructure](bodystructure.html): Who this is about* [CarePlan](careplan.html): Who the care plan is for* [CareTeam](careteam.html): Who care team is for* [ChargeItem](chargeitem.html): Individual service was done for/to* [Claim](claim.html): Patient receiving the products or services* [ClaimResponse](claimresponse.html): The subject of care* [ClinicalImpression](clinicalimpression.html): Patient assessed* [Communication](communication.html): Focus of message* [CommunicationRequest](communicationrequest.html): Focus of message* [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* [Contract](contract.html): The identity of the subject of the contract (if a patient)* [Coverage](coverage.html): Retrieve coverages for a patient* [CoverageEligibilityRequest](coverageeligibilityrequest.html): The reference to the patient* [CoverageEligibilityResponse](coverageeligibilityresponse.html): The reference to the patient* [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* [DocumentReference](documentreference.html): Who/what is the subject of the document* [Encounter](encounter.html): The patient present at the encounter* [EnrollmentRequest](enrollmentrequest.html): The party to be enrolled* [EpisodeOfCare](episodeofcare.html): The patient who is the focus of this episode of care* [ExplanationOfBenefit](explanationofbenefit.html): The reference to the patient* [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* [GuidanceResponse](guidanceresponse.html): The identity of a patient to search for guidance response results* [ImagingSelection](imagingselection.html): Who the study is about* [ImagingStudy](imagingstudy.html): Who the study is about* [Immunization](immunization.html): The patient for the vaccination record* [ImmunizationEvaluation](immunizationevaluation.html): The patient being evaluated* [ImmunizationRecommendation](immunizationrecommendation.html): Who this profile is for* [Invoice](invoice.html): Recipient(s) of goods and services* [List](list.html): If all resources have the same subject* [MeasureReport](measurereport.html): The identity of a patient to search for individual measure report results for* [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.* [MolecularSequence](molecularsequence.html): The subject that the sequence is about* [NutritionIntake](nutritionintake.html): Returns statements for a specific patient.* [NutritionOrder](nutritionorder.html): The identity of the individual or set of individuals who requires the diet, formula or nutritional supplement* [Observation](observation.html): The subject that the observation is about (if patient)* [Person](person.html): The Person links to this Patient* [Procedure](procedure.html): Search by subject - a patient* [Provenance](provenance.html): Where the activity involved patient data* [QuestionnaireResponse](questionnaireresponse.html): The patient that is the subject of the questionnaire response* [RelatedPerson](relatedperson.html): The patient this related person is related to* [RequestOrchestration](requestorchestration.html): The identity of a patient to search for request orchestrations* [ResearchSubject](researchsubject.html): Who or what is part of study* [RiskAssessment](riskassessment.html): Who/what does assessment apply to?* [ServiceRequest](servicerequest.html): Search by subject - a patient* [Specimen](specimen.html): The patient the specimen comes from* [SupplyDelivery](supplydelivery.html): Patient for whom the item is supplied* [SupplyRequest](supplyrequest.html): The patient or subject for whom the supply is destined* [Task](task.html): Search by patient* [VisionPrescription](visionprescription.html): The identity of a patient to list dispenses for")
120                        @OptionalParam(name="patient", targetTypes={  } )
121                        ReferenceAndListParam thePatient, 
122   
123
124                        @Description(shortDefinition="When the activity was recorded / updated")
125                        @OptionalParam(name="recorded")
126                        DateRangeParam theRecorded, 
127   
128
129                        @Description(shortDefinition="Indication of the reason the entity signed the object(s)")
130                        @OptionalParam(name="signature-type")
131                        TokenAndListParam theSignature_type,
132   
133
134                        @Description(shortDefinition="Target Reference(s) (usually version specific)")
135                        @OptionalParam(name="target", targetTypes={  } )
136                        ReferenceAndListParam theTarget, 
137   
138
139                        @Description(shortDefinition="When the activity occurred")
140                        @OptionalParam(name="when")
141                        DateRangeParam theWhen, 
142
143                        @RawParam
144                        Map<String, List<String>> theAdditionalRawParams,
145
146                        @Description(shortDefinition="Only return resources which were last updated as specified by the given range")
147                        @OptionalParam(name="_lastUpdated")
148                        DateRangeParam theLastUpdated, 
149
150                        @IncludeParam
151                        Set<Include> theIncludes,
152
153                        @IncludeParam(reverse=true)
154                        Set<Include> theRevIncludes,
155
156                        @Sort
157                        SortSpec theSort,
158                        
159                        @ca.uhn.fhir.rest.annotation.Count
160                        Integer theCount,
161
162                        @ca.uhn.fhir.rest.annotation.Offset
163                        Integer theOffset,
164
165                        SummaryEnum theSummaryMode,
166
167                        SearchTotalModeEnum theSearchTotalMode,
168
169                        SearchContainedModeEnum theSearchContainedMode
170
171                        ) {
172                startRequest(theServletRequest);
173                try {
174                        SearchParameterMap paramMap = new SearchParameterMap();
175                        paramMap.add(ca.uhn.fhir.rest.api.Constants.PARAM_FILTER, theFtFilter);
176                        paramMap.add(ca.uhn.fhir.rest.api.Constants.PARAM_CONTENT, theFtContent);
177                        paramMap.add(ca.uhn.fhir.rest.api.Constants.PARAM_TEXT, theFtText);
178                        paramMap.add(ca.uhn.fhir.rest.api.Constants.PARAM_TAG, theSearchForTag);
179                        paramMap.add(ca.uhn.fhir.rest.api.Constants.PARAM_SECURITY, theSearchForSecurity);
180                        paramMap.add(ca.uhn.fhir.rest.api.Constants.PARAM_PROFILE, theSearchForProfile);
181                        paramMap.add(ca.uhn.fhir.rest.api.Constants.PARAM_SOURCE, theSearchForSource);
182                        paramMap.add("_has", theHas);
183                        paramMap.add("_id", the_id);
184                        paramMap.add("_text", the_text);
185                        paramMap.add("activity", theActivity);
186                        paramMap.add("agent", theAgent);
187                        paramMap.add("agent-role", theAgent_role);
188                        paramMap.add("agent-type", theAgent_type);
189                        paramMap.add("based-on", theBased_on);
190                        paramMap.add("encounter", theEncounter);
191                        paramMap.add("entity", theEntity);
192                        paramMap.add("location", theLocation);
193                        paramMap.add("patient", thePatient);
194                        paramMap.add("recorded", theRecorded);
195                        paramMap.add("signature-type", theSignature_type);
196                        paramMap.add("target", theTarget);
197                        paramMap.add("when", theWhen);
198                        paramMap.setRevIncludes(theRevIncludes);
199                        paramMap.setLastUpdated(theLastUpdated);
200                        paramMap.setIncludes(theIncludes);
201                        paramMap.setSort(theSort);
202                        paramMap.setCount(theCount);
203                        paramMap.setOffset(theOffset);
204                        paramMap.setSummaryMode(theSummaryMode);
205                        paramMap.setSearchTotalMode(theSearchTotalMode);
206                        paramMap.setSearchContainedMode(theSearchContainedMode);
207
208                        getDao().translateRawParameters(theAdditionalRawParams, paramMap);
209
210                        ca.uhn.fhir.rest.api.server.IBundleProvider retVal = getDao().search(paramMap, theRequestDetails, theServletResponse);
211                        return retVal;
212                } finally {
213                        endRequest(theServletRequest);
214                }
215        }
216
217}