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 ListResourceResourceProvider extends 
020        ca.uhn.fhir.jpa.provider.BaseJpaResourceProvider<ListResource>
021        {
022
023        @Override
024        public Class<ListResource> getResourceType() {
025                return ListResource.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                        @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 the contents of the resource's data using a list")
060                        @OptionalParam(name=ca.uhn.fhir.rest.api.Constants.PARAM_LIST)
061                        StringAndListParam theList,
062
063
064                        @Description(shortDefinition="Search for resources which have the given source value (Resource.meta.source)")
065                        @OptionalParam(name=ca.uhn.fhir.rest.api.Constants.PARAM_SOURCE)
066                        UriAndListParam theSearchForSource,
067
068                        @Description(shortDefinition="Return resources linked to by the given target")
069                        @OptionalParam(name="_has")
070                        HasAndListParam theHas, 
071
072   
073
074                        @Description(shortDefinition="The ID of the resource")
075                        @OptionalParam(name="_id")
076                        TokenAndListParam the_id,
077   
078
079                        @Description(shortDefinition="Search on the narrative of the resource")
080                        @OptionalParam(name="_text")
081                        SpecialAndListParam the_text,
082   
083
084                        @Description(shortDefinition="Multiple Resources: * [AdverseEvent](adverseevent.html): Event or incident that occurred or was averted* [AllergyIntolerance](allergyintolerance.html): Code that identifies the allergy or intolerance* [AuditEvent](auditevent.html): More specific code for the event* [Basic](basic.html): Kind of Resource* [ChargeItem](chargeitem.html): A code that identifies the charge, like a billing code* [Condition](condition.html): Code for the condition* [DetectedIssue](detectedissue.html): Issue Type, e.g. drug-drug, duplicate therapy, etc.* [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* [ImagingSelection](imagingselection.html): The imaging selection status* [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* [NutritionIntake](nutritionintake.html): Returns statements of this code of NutritionIntake* [Observation](observation.html): The code of the observation type* [Procedure](procedure.html): A code to identify a  procedure* [RequestOrchestration](requestorchestration.html): The code of the request orchestration* [Task](task.html): Search by task code")
085                        @OptionalParam(name="code")
086                        TokenAndListParam theCode,
087   
088
089                        @Description(shortDefinition="Multiple Resources: * [AdverseEvent](adverseevent.html): When the event occurred* [AllergyIntolerance](allergyintolerance.html): Date first version of the resource instance was recorded* [Appointment](appointment.html): Appointment date/time.* [AuditEvent](auditevent.html): Time when the event 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* [DocumentReference](documentreference.html): When this document reference was created* [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* [ImmunizationEvaluation](immunizationevaluation.html): Date the evaluation was generated* [ImmunizationRecommendation](immunizationrecommendation.html): Date recommendation(s) created* [Invoice](invoice.html): Invoice date / posting date* [List](list.html): When the list was prepared* [MeasureReport](measurereport.html): The date of the measure report* [NutritionIntake](nutritionintake.html): Date when patient was taking (or not taking) the medication* [Observation](observation.html): Clinically relevant time/time-period for observation* [Procedure](procedure.html): When the procedure occurred or is occurring* [ResearchSubject](researchsubject.html): Start and end of participation* [RiskAssessment](riskassessment.html): When was assessment made?* [SupplyRequest](supplyrequest.html): When the request was made")
090                        @OptionalParam(name="date")
091                        DateRangeParam theDate, 
092   
093
094                        @Description(shortDefinition="Why list is empty")
095                        @OptionalParam(name="empty-reason")
096                        TokenAndListParam theEmpty_reason,
097   
098
099                        @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")
100                        @OptionalParam(name="encounter", targetTypes={  } )
101                        ReferenceAndListParam theEncounter, 
102   
103
104                        @Description(shortDefinition="Multiple Resources: * [Account](account.html): Account number* [AdverseEvent](adverseevent.html): Business identifier for the event* [AllergyIntolerance](allergyintolerance.html): External ids for this item* [Appointment](appointment.html): An Identifier of the Appointment* [AppointmentResponse](appointmentresponse.html): An Identifier in this appointment response* [Basic](basic.html): Business identifier* [BodyStructure](bodystructure.html): Bodystructure identifier* [CarePlan](careplan.html): External Ids for this plan* [CareTeam](careteam.html): External Ids for this team* [ChargeItem](chargeitem.html): Business Identifier for item* [Claim](claim.html): The primary identifier of the financial resource* [ClaimResponse](claimresponse.html): The identity of the ClaimResponse* [ClinicalImpression](clinicalimpression.html): Business identifier* [Communication](communication.html): Unique identifier* [CommunicationRequest](communicationrequest.html): Unique identifier* [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)* [Contract](contract.html): The identity of the contract* [Coverage](coverage.html): The primary identifier of the insured and the coverage* [CoverageEligibilityRequest](coverageeligibilityrequest.html): The business identifier of the Eligibility* [CoverageEligibilityResponse](coverageeligibilityresponse.html): The business identifier* [DetectedIssue](detectedissue.html): Unique id for the detected issue* [DeviceRequest](devicerequest.html): Business identifier for request/order* [DeviceUsage](deviceusage.html): Search by identifier* [DiagnosticReport](diagnosticreport.html): An identifier for the report* [DocumentReference](documentreference.html): Identifier of the attachment binary* [Encounter](encounter.html): Identifier(s) by which this encounter is known* [EnrollmentRequest](enrollmentrequest.html): The business identifier of the Enrollment* [EpisodeOfCare](episodeofcare.html): Business Identifier(s) relevant for this EpisodeOfCare* [ExplanationOfBenefit](explanationofbenefit.html): The business identifier of the Explanation of Benefit* [FamilyMemberHistory](familymemberhistory.html): A search by a record identifier* [Flag](flag.html): Business identifier* [Goal](goal.html): External Ids for this goal* [GuidanceResponse](guidanceresponse.html): The identifier of the guidance response* [ImagingSelection](imagingselection.html): Identifiers for the imaging selection* [ImagingStudy](imagingstudy.html): Identifiers for the Study, such as DICOM Study Instance UID* [Immunization](immunization.html): Business identifier* [ImmunizationEvaluation](immunizationevaluation.html): ID of the evaluation* [ImmunizationRecommendation](immunizationrecommendation.html): Business identifier* [Invoice](invoice.html): Business Identifier for item* [List](list.html): Business identifier* [MeasureReport](measurereport.html): External identifier of the measure report to be returned* [Medication](medication.html): Returns medications with this external 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* [MolecularSequence](molecularsequence.html): The unique identity for a particular sequence* [NutritionIntake](nutritionintake.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* [Person](person.html): A person Identifier* [Procedure](procedure.html): A unique identifier for a procedure* [QuestionnaireResponse](questionnaireresponse.html): The unique identifier for the questionnaire response* [RelatedPerson](relatedperson.html): An Identifier of the RelatedPerson* [RequestOrchestration](requestorchestration.html): External identifiers for the request orchestration* [ResearchSubject](researchsubject.html): Business Identifier for research subject in a study* [RiskAssessment](riskassessment.html): Unique identifier for the assessment* [ServiceRequest](servicerequest.html): Identifiers assigned to this order* [Specimen](specimen.html): The unique identifier associated with the specimen* [SupplyDelivery](supplydelivery.html): External identifier* [SupplyRequest](supplyrequest.html): Business Identifier for SupplyRequest* [Task](task.html): Search for a task instance by its business identifier* [VisionPrescription](visionprescription.html): Return prescriptions with this external identifier")
105                        @OptionalParam(name="identifier")
106                        TokenAndListParam theIdentifier,
107   
108
109                        @Description(shortDefinition="Actual entry")
110                        @OptionalParam(name="item", targetTypes={  } )
111                        ReferenceAndListParam theItem, 
112   
113
114                        @Description(shortDefinition="The annotation  - text content (as markdown)")
115                        @OptionalParam(name="notes")
116                        StringAndListParam theNotes, 
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="Who and/or what defined the list contents (aka Author)")
125                        @OptionalParam(name="source", targetTypes={  } )
126                        ReferenceAndListParam theSource, 
127   
128
129                        @Description(shortDefinition="current | retired | entered-in-error")
130                        @OptionalParam(name="status")
131                        TokenAndListParam theStatus,
132   
133
134                        @Description(shortDefinition="If all resources have the same subject")
135                        @OptionalParam(name="subject", targetTypes={  } )
136                        ReferenceAndListParam theSubject, 
137   
138
139                        @Description(shortDefinition="Descriptive name for the list")
140                        @OptionalParam(name="title")
141                        StringAndListParam theTitle, 
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(ca.uhn.fhir.rest.api.Constants.PARAM_LIST, theList);
183                        paramMap.add("_has", theHas);
184                        paramMap.add("_id", the_id);
185                        paramMap.add("_text", the_text);
186                        paramMap.add("code", theCode);
187                        paramMap.add("date", theDate);
188                        paramMap.add("empty-reason", theEmpty_reason);
189                        paramMap.add("encounter", theEncounter);
190                        paramMap.add("identifier", theIdentifier);
191                        paramMap.add("item", theItem);
192                        paramMap.add("notes", theNotes);
193                        paramMap.add("patient", thePatient);
194                        paramMap.add("source", theSource);
195                        paramMap.add("status", theStatus);
196                        paramMap.add("subject", theSubject);
197                        paramMap.add("title", theTitle);
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}