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 EncounterResourceProvider extends 
020        ca.uhn.fhir.jpa.provider.BaseJpaResourceProviderEncounter<Encounter>
021        {
022
023        @Override
024        public Class<Encounter> getResourceType() {
025                return Encounter.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                        @Description(shortDefinition="The language of the resource")
064                        @OptionalParam(name=ca.uhn.fhir.rest.api.Constants.PARAM_LANGUAGE)
065                        TokenAndListParam theResourceLanguage,
066
067                        @Description(shortDefinition="Search for resources which have the given source value (Resource.meta.source)")
068                        @OptionalParam(name=ca.uhn.fhir.rest.api.Constants.PARAM_SOURCE)
069                        UriAndListParam theSearchForSource,
070
071                        @Description(shortDefinition="Return resources linked to by the given target")
072                        @OptionalParam(name="_has")
073                        HasAndListParam theHas, 
074
075   
076
077                        @Description(shortDefinition="The ID of the resource")
078                        @OptionalParam(name="_id")
079                        TokenAndListParam the_id,
080   
081
082                        @Description(shortDefinition="Search on the narrative of the resource")
083                        @OptionalParam(name="_text")
084                        SpecialAndListParam the_text,
085   
086
087                        @Description(shortDefinition="The set of accounts that may be used for billing for this Encounter")
088                        @OptionalParam(name="account", targetTypes={  } )
089                        ReferenceAndListParam theAccount, 
090   
091
092                        @Description(shortDefinition="The appointment that scheduled this encounter")
093                        @OptionalParam(name="appointment", targetTypes={  } )
094                        ReferenceAndListParam theAppointment, 
095   
096
097                        @Description(shortDefinition="The ServiceRequest that initiated this encounter")
098                        @OptionalParam(name="based-on", targetTypes={  } )
099                        ReferenceAndListParam theBased_on, 
100   
101
102                        @Description(shortDefinition="Careteam allocated to participate in the encounter")
103                        @OptionalParam(name="careteam", targetTypes={  } )
104                        ReferenceAndListParam theCareteam, 
105   
106
107                        @Description(shortDefinition="Classification of patient encounter")
108                        @OptionalParam(name="class")
109                        TokenAndListParam theClass,
110   
111
112                        @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")
113                        @OptionalParam(name="date")
114                        DateRangeParam theDate, 
115   
116
117                        @Description(shortDefinition="The actual start date of the Encounter")
118                        @OptionalParam(name="date-start")
119                        DateRangeParam theDate_start, 
120   
121
122                        @Description(shortDefinition="The diagnosis or procedure relevant to the encounter (coded)")
123                        @OptionalParam(name="diagnosis-code")
124                        TokenAndListParam theDiagnosis_code,
125   
126
127                        @Description(shortDefinition="The diagnosis or procedure relevant to the encounter (resource reference)")
128                        @OptionalParam(name="diagnosis-reference", targetTypes={  } )
129                        ReferenceAndListParam theDiagnosis_reference, 
130   
131
132                        @Description(shortDefinition="The actual end date of the Encounter")
133                        @OptionalParam(name="end-date")
134                        DateRangeParam theEnd_date, 
135   
136
137                        @Description(shortDefinition="Episode(s) of care that this encounter should be recorded against")
138                        @OptionalParam(name="episode-of-care", targetTypes={  } )
139                        ReferenceAndListParam theEpisode_of_care, 
140   
141
142                        @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")
143                        @OptionalParam(name="identifier")
144                        TokenAndListParam theIdentifier,
145   
146
147                        @Description(shortDefinition="Length of encounter in days")
148                        @OptionalParam(name="length")
149                        QuantityAndListParam theLength, 
150   
151
152                        @Description(shortDefinition="Location the encounter takes place")
153                        @OptionalParam(name="location", targetTypes={  } )
154                        ReferenceAndListParam theLocation, 
155   
156
157                        @Description(shortDefinition="Another Encounter this encounter is part of")
158                        @OptionalParam(name="part-of", targetTypes={  } )
159                        ReferenceAndListParam thePart_of, 
160   
161
162                        @Description(shortDefinition="Persons involved in the encounter other than the patient")
163                        @OptionalParam(name="participant", targetTypes={  } )
164                        ReferenceAndListParam theParticipant, 
165   
166
167                        @Description(shortDefinition="Role of participant in encounter")
168                        @OptionalParam(name="participant-type")
169                        TokenAndListParam theParticipant_type,
170   
171
172                        @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")
173                        @OptionalParam(name="patient", targetTypes={  } )
174                        ReferenceAndListParam thePatient, 
175   
176
177                        @Description(shortDefinition="Persons involved in the encounter other than the patient")
178                        @OptionalParam(name="practitioner", targetTypes={  } )
179                        ReferenceAndListParam thePractitioner, 
180   
181
182                        @Description(shortDefinition="Reference to a concept (coded)")
183                        @OptionalParam(name="reason-code")
184                        TokenAndListParam theReason_code,
185   
186
187                        @Description(shortDefinition="Reference to a resource (resource reference)")
188                        @OptionalParam(name="reason-reference", targetTypes={  } )
189                        ReferenceAndListParam theReason_reference, 
190   
191
192                        @Description(shortDefinition="The organization (facility) responsible for this encounter")
193                        @OptionalParam(name="service-provider", targetTypes={  } )
194                        ReferenceAndListParam theService_provider, 
195   
196
197                        @Description(shortDefinition="Wheelchair, translator, stretcher, etc.")
198                        @OptionalParam(name="special-arrangement")
199                        TokenAndListParam theSpecial_arrangement,
200   
201
202                        @Description(shortDefinition="planned | in-progress | on-hold | completed | cancelled | entered-in-error | unknown")
203                        @OptionalParam(name="status")
204                        TokenAndListParam theStatus,
205   
206
207                        @Description(shortDefinition="The patient or group present at the encounter")
208                        @OptionalParam(name="subject", targetTypes={  } )
209                        ReferenceAndListParam theSubject, 
210   
211
212                        @Description(shortDefinition="The current status of the subject in relation to the Encounter")
213                        @OptionalParam(name="subject-status")
214                        TokenAndListParam theSubject_status,
215   
216
217                        @Description(shortDefinition="Multiple Resources: * [Account](account.html): E.g. patient, expense, depreciation* [AllergyIntolerance](allergyintolerance.html): allergy | intolerance - Underlying mechanism (if known)* [Composition](composition.html): Kind of composition (LOINC if possible)* [Coverage](coverage.html): The kind of coverage (health plan, auto, Workers Compensation)* [DocumentReference](documentreference.html): Kind of document (LOINC if possible)* [Encounter](encounter.html): Specific type of encounter* [EpisodeOfCare](episodeofcare.html): Type/class  - e.g. specialist referral, disease management* [Invoice](invoice.html): Type of Invoice* [MedicationDispense](medicationdispense.html): Returns dispenses of a specific type* [MolecularSequence](molecularsequence.html): Amino Acid Sequence/ DNA Sequence / RNA Sequence* [Specimen](specimen.html): The specimen type")
218                        @OptionalParam(name="type")
219                        TokenAndListParam theType,
220
221                        @RawParam
222                        Map<String, List<String>> theAdditionalRawParams,
223
224                        @Description(shortDefinition="Only return resources which were last updated as specified by the given range")
225                        @OptionalParam(name="_lastUpdated")
226                        DateRangeParam theLastUpdated, 
227
228                        @IncludeParam
229                        Set<Include> theIncludes,
230
231                        @IncludeParam(reverse=true)
232                        Set<Include> theRevIncludes,
233
234                        @Sort
235                        SortSpec theSort,
236                        
237                        @ca.uhn.fhir.rest.annotation.Count
238                        Integer theCount,
239
240                        @ca.uhn.fhir.rest.annotation.Offset
241                        Integer theOffset,
242
243                        SummaryEnum theSummaryMode,
244
245                        SearchTotalModeEnum theSearchTotalMode,
246
247                        SearchContainedModeEnum theSearchContainedMode
248
249                        ) {
250                startRequest(theServletRequest);
251                try {
252                        SearchParameterMap paramMap = new SearchParameterMap();
253                        paramMap.add(ca.uhn.fhir.rest.api.Constants.PARAM_FILTER, theFtFilter);
254                        paramMap.add(ca.uhn.fhir.rest.api.Constants.PARAM_CONTENT, theFtContent);
255                        paramMap.add(ca.uhn.fhir.rest.api.Constants.PARAM_TEXT, theFtText);
256                        paramMap.add(ca.uhn.fhir.rest.api.Constants.PARAM_TAG, theSearchForTag);
257                        paramMap.add(ca.uhn.fhir.rest.api.Constants.PARAM_SECURITY, theSearchForSecurity);
258                        paramMap.add(ca.uhn.fhir.rest.api.Constants.PARAM_PROFILE, theSearchForProfile);
259                        paramMap.add(ca.uhn.fhir.rest.api.Constants.PARAM_SOURCE, theSearchForSource);
260                        paramMap.add(ca.uhn.fhir.rest.api.Constants.PARAM_LIST, theList);
261                        paramMap.add(ca.uhn.fhir.rest.api.Constants.PARAM_LANGUAGE, theResourceLanguage);
262
263                        paramMap.add("_has", theHas);
264                        paramMap.add("_id", the_id);
265                        paramMap.add("_text", the_text);
266                        paramMap.add("account", theAccount);
267                        paramMap.add("appointment", theAppointment);
268                        paramMap.add("based-on", theBased_on);
269                        paramMap.add("careteam", theCareteam);
270                        paramMap.add("class", theClass);
271                        paramMap.add("date", theDate);
272                        paramMap.add("date-start", theDate_start);
273                        paramMap.add("diagnosis-code", theDiagnosis_code);
274                        paramMap.add("diagnosis-reference", theDiagnosis_reference);
275                        paramMap.add("end-date", theEnd_date);
276                        paramMap.add("episode-of-care", theEpisode_of_care);
277                        paramMap.add("identifier", theIdentifier);
278                        paramMap.add("length", theLength);
279                        paramMap.add("location", theLocation);
280                        paramMap.add("part-of", thePart_of);
281                        paramMap.add("participant", theParticipant);
282                        paramMap.add("participant-type", theParticipant_type);
283                        paramMap.add("patient", thePatient);
284                        paramMap.add("practitioner", thePractitioner);
285                        paramMap.add("reason-code", theReason_code);
286                        paramMap.add("reason-reference", theReason_reference);
287                        paramMap.add("service-provider", theService_provider);
288                        paramMap.add("special-arrangement", theSpecial_arrangement);
289                        paramMap.add("status", theStatus);
290                        paramMap.add("subject", theSubject);
291                        paramMap.add("subject-status", theSubject_status);
292                        paramMap.add("type", theType);
293                        paramMap.setRevIncludes(theRevIncludes);
294                        paramMap.setLastUpdated(theLastUpdated);
295                        paramMap.setIncludes(theIncludes);
296                        paramMap.setSort(theSort);
297                        paramMap.setCount(theCount);
298                        paramMap.setOffset(theOffset);
299                        paramMap.setSummaryMode(theSummaryMode);
300                        paramMap.setSearchTotalMode(theSearchTotalMode);
301                        paramMap.setSearchContainedMode(theSearchContainedMode);
302
303                        getDao().translateRawParameters(theAdditionalRawParams, paramMap);
304
305                        ca.uhn.fhir.rest.api.server.IBundleProvider retVal = getDao().search(paramMap, theRequestDetails, theServletResponse);
306                        return retVal;
307                } finally {
308                        endRequest(theServletRequest);
309                }
310        }
311
312}