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 PatientResourceProvider extends 
020        ca.uhn.fhir.jpa.provider.BaseJpaResourceProviderPatient<Patient>
021        {
022
023        @Override
024        public Class<Patient> getResourceType() {
025                return Patient.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                        StringAndListParam the_text, 
085   
086
087                        @Description(shortDefinition="Whether the patient record is active")
088                        @OptionalParam(name="active")
089                        TokenAndListParam theActive,
090   
091
092                        @Description(shortDefinition="Multiple Resources: * [Patient](patient.html): A server defined search that may match any of the string fields in the Address, including line, city, district, state, country, postalCode, and/or text* [Person](person.html): A server defined search that may match any of the string fields in the Address, including line, city, district, state, country, postalCode, and/or text* [Practitioner](practitioner.html): A server defined search that may match any of the string fields in the Address, including line, city, district, state, country, postalCode, and/or text* [RelatedPerson](relatedperson.html): A server defined search that may match any of the string fields in the Address, including line, city, district, state, country, postalCode, and/or text")
093                        @OptionalParam(name="address")
094                        StringAndListParam theAddress, 
095   
096
097                        @Description(shortDefinition="Multiple Resources: * [Patient](patient.html): A city specified in an address* [Person](person.html): A city specified in an address* [Practitioner](practitioner.html): A city specified in an address* [RelatedPerson](relatedperson.html): A city specified in an address")
098                        @OptionalParam(name="address-city")
099                        StringAndListParam theAddress_city, 
100   
101
102                        @Description(shortDefinition="Multiple Resources: * [Patient](patient.html): A country specified in an address* [Person](person.html): A country specified in an address* [Practitioner](practitioner.html): A country specified in an address* [RelatedPerson](relatedperson.html): A country specified in an address")
103                        @OptionalParam(name="address-country")
104                        StringAndListParam theAddress_country, 
105   
106
107                        @Description(shortDefinition="Multiple Resources: * [Patient](patient.html): A postalCode specified in an address* [Person](person.html): A postal code specified in an address* [Practitioner](practitioner.html): A postalCode specified in an address* [RelatedPerson](relatedperson.html): A postal code specified in an address")
108                        @OptionalParam(name="address-postalcode")
109                        StringAndListParam theAddress_postalcode, 
110   
111
112                        @Description(shortDefinition="Multiple Resources: * [Patient](patient.html): A state specified in an address* [Person](person.html): A state specified in an address* [Practitioner](practitioner.html): A state specified in an address* [RelatedPerson](relatedperson.html): A state specified in an address")
113                        @OptionalParam(name="address-state")
114                        StringAndListParam theAddress_state, 
115   
116
117                        @Description(shortDefinition="Multiple Resources: * [Patient](patient.html): A use code specified in an address* [Person](person.html): A use code specified in an address* [Practitioner](practitioner.html): A use code specified in an address* [RelatedPerson](relatedperson.html): A use code specified in an address")
118                        @OptionalParam(name="address-use")
119                        TokenAndListParam theAddress_use,
120   
121
122                        @Description(shortDefinition="Searches for patients based on age as calculated based on current date and date of birth.  Deceased patients are excluded from the search.")
123                        @OptionalParam(name="age")
124                        NumberAndListParam theAge, 
125   
126
127                        @Description(shortDefinition="Search based on whether a patient was part of a multiple birth or not.")
128                        @OptionalParam(name="birthOrderBoolean")
129                        TokenAndListParam theBirthOrderBoolean,
130   
131
132                        @Description(shortDefinition="Multiple Resources: * [Patient](patient.html): The patient's date of birth* [Person](person.html): The person's date of birth* [RelatedPerson](relatedperson.html): The Related Person's date of birth")
133                        @OptionalParam(name="birthdate")
134                        DateRangeParam theBirthdate, 
135   
136
137                        @Description(shortDefinition="The date of death has been provided and satisfies this search value")
138                        @OptionalParam(name="death-date")
139                        DateRangeParam theDeath_date, 
140   
141
142                        @Description(shortDefinition="This patient has been marked as deceased, or as a death date entered")
143                        @OptionalParam(name="deceased")
144                        TokenAndListParam theDeceased,
145   
146
147                        @Description(shortDefinition="Multiple Resources: * [Patient](patient.html): A value in an email contact* [Person](person.html): A value in an email contact* [Practitioner](practitioner.html): A value in an email contact* [PractitionerRole](practitionerrole.html): A value in an email contact* [RelatedPerson](relatedperson.html): A value in an email contact")
148                        @OptionalParam(name="email")
149                        TokenAndListParam theEmail,
150   
151
152                        @Description(shortDefinition="Multiple Resources: * [Patient](patient.html): A portion of the family name of the patient* [Practitioner](practitioner.html): A portion of the family name")
153                        @OptionalParam(name="family")
154                        StringAndListParam theFamily, 
155   
156
157                        @Description(shortDefinition="Multiple Resources: * [Patient](patient.html): Gender of the patient* [Person](person.html): The gender of the person* [Practitioner](practitioner.html): Gender of the practitioner* [RelatedPerson](relatedperson.html): Gender of the related person")
158                        @OptionalParam(name="gender")
159                        TokenAndListParam theGender,
160   
161
162                        @Description(shortDefinition="Patient's nominated general practitioner, not the organization that manages the record")
163                        @OptionalParam(name="general-practitioner", targetTypes={  } )
164                        ReferenceAndListParam theGeneral_practitioner, 
165   
166
167                        @Description(shortDefinition="Multiple Resources: * [Patient](patient.html): A portion of the given name of the patient* [Practitioner](practitioner.html): A portion of the given name")
168                        @OptionalParam(name="given")
169                        StringAndListParam theGiven, 
170   
171
172                        @Description(shortDefinition="A patient identifier")
173                        @OptionalParam(name="identifier")
174                        TokenAndListParam theIdentifier,
175   
176
177                        @Description(shortDefinition="Language code (irrespective of use value)")
178                        @OptionalParam(name="language")
179                        TokenAndListParam theLanguage,
180   
181
182                        @Description(shortDefinition="All patients linked to the given patient")
183                        @OptionalParam(name="link", targetTypes={  } )
184                        ReferenceAndListParam theLink, 
185   
186
187                        @Description(shortDefinition="Search based on patient's mother's maiden name")
188                        @OptionalParam(name="mothersMaidenName")
189                        StringAndListParam theMothersMaidenName, 
190   
191
192                        @Description(shortDefinition="A server defined search that may match any of the string fields in the HumanName, including family, give, prefix, suffix, suffix, and/or text")
193                        @OptionalParam(name="name")
194                        StringAndListParam theName, 
195   
196
197                        @Description(shortDefinition="The organization that is the custodian of the patient record")
198                        @OptionalParam(name="organization", targetTypes={  } )
199                        ReferenceAndListParam theOrganization, 
200   
201
202                        @Description(shortDefinition="Search by url for a participation agreement, which is stored in a DocumentReference")
203                        @OptionalParam(name="part-agree", targetTypes={  } )
204                        ReferenceAndListParam thePart_agree, 
205   
206
207                        @Description(shortDefinition="Multiple Resources: * [Patient](patient.html): A value in a phone contact* [Person](person.html): A value in a phone contact* [Practitioner](practitioner.html): A value in a phone contact* [PractitionerRole](practitionerrole.html): A value in a phone contact* [RelatedPerson](relatedperson.html): A value in a phone contact")
208                        @OptionalParam(name="phone")
209                        TokenAndListParam thePhone,
210   
211
212                        @Description(shortDefinition="Multiple Resources: * [Patient](patient.html): A portion of either family or given name using some kind of phonetic matching algorithm* [Person](person.html): A portion of name using some kind of phonetic matching algorithm* [Practitioner](practitioner.html): A portion of either family or given name using some kind of phonetic matching algorithm* [RelatedPerson](relatedperson.html): A portion of name using some kind of phonetic matching algorithm")
213                        @OptionalParam(name="phonetic")
214                        StringAndListParam thePhonetic, 
215   
216
217                        @Description(shortDefinition="Multiple Resources: * [Patient](patient.html): The value in any kind of telecom details of the patient* [Person](person.html): The value in any kind of contact* [Practitioner](practitioner.html): The value in any kind of contact* [PractitionerRole](practitionerrole.html): The value in any kind of contact* [RelatedPerson](relatedperson.html): The value in any kind of contact")
218                        @OptionalParam(name="telecom")
219                        TokenAndListParam theTelecom,
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("active", theActive);
267                        paramMap.add("address", theAddress);
268                        paramMap.add("address-city", theAddress_city);
269                        paramMap.add("address-country", theAddress_country);
270                        paramMap.add("address-postalcode", theAddress_postalcode);
271                        paramMap.add("address-state", theAddress_state);
272                        paramMap.add("address-use", theAddress_use);
273                        paramMap.add("age", theAge);
274                        paramMap.add("birthOrderBoolean", theBirthOrderBoolean);
275                        paramMap.add("birthdate", theBirthdate);
276                        paramMap.add("death-date", theDeath_date);
277                        paramMap.add("deceased", theDeceased);
278                        paramMap.add("email", theEmail);
279                        paramMap.add("family", theFamily);
280                        paramMap.add("gender", theGender);
281                        paramMap.add("general-practitioner", theGeneral_practitioner);
282                        paramMap.add("given", theGiven);
283                        paramMap.add("identifier", theIdentifier);
284                        paramMap.add("language", theLanguage);
285                        paramMap.add("link", theLink);
286                        paramMap.add("mothersMaidenName", theMothersMaidenName);
287                        paramMap.add("name", theName);
288                        paramMap.add("organization", theOrganization);
289                        paramMap.add("part-agree", thePart_agree);
290                        paramMap.add("phone", thePhone);
291                        paramMap.add("phonetic", thePhonetic);
292                        paramMap.add("telecom", theTelecom);
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}