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 SpecimenDefinitionResourceProvider extends 
020        ca.uhn.fhir.jpa.provider.BaseJpaResourceProvider<SpecimenDefinition>
021        {
022
023        @Override
024        public Class<SpecimenDefinition> getResourceType() {
025                return SpecimenDefinition.class;
026        }
027
028        @Search(allowUnknownParams=true)
029        public ca.uhn.fhir.rest.api.server.IBundleProvider search(
030                        jakarta.servlet.http.HttpServletRequest theServletRequest,
031                        jakarta.servlet.http.HttpServletResponse theServletResponse,
032
033                        ca.uhn.fhir.rest.api.server.RequestDetails theRequestDetails,
034
035                        @Description(shortDefinition="Search the contents of the resource's data using a filter")
036                        @OptionalParam(name=ca.uhn.fhir.rest.api.Constants.PARAM_FILTER)
037                        StringAndListParam theFtFilter,
038
039                        @Description(shortDefinition="Search the contents of the resource's data using a fulltext search")
040                        @OptionalParam(name=ca.uhn.fhir.rest.api.Constants.PARAM_CONTENT)
041                        StringAndListParam theFtContent, 
042
043                        @Description(shortDefinition="Search the contents of the resource's narrative using a fulltext search")
044                        @OptionalParam(name=ca.uhn.fhir.rest.api.Constants.PARAM_TEXT)
045                        StringAndListParam theFtText, 
046
047
048                        @Description(shortDefinition="Search the contents of the resource's data using a list")
049                        @OptionalParam(name=ca.uhn.fhir.rest.api.Constants.PARAM_LIST)
050                        StringAndListParam theList,
051
052                        @Description(shortDefinition="The language of the resource")
053                        @OptionalParam(name=ca.uhn.fhir.rest.api.Constants.PARAM_LANGUAGE)
054                        TokenAndListParam theResourceLanguage,
055
056                        @Description(shortDefinition="Search for resources which have the given source value (Resource.meta.source)")
057                        @OptionalParam(name=ca.uhn.fhir.rest.api.Constants.PARAM_SOURCE)
058                        UriAndListParam theSearchForSource,
059
060                        @Description(shortDefinition="Return resources linked to by the given target")
061                        @OptionalParam(name="_has")
062                        HasAndListParam theHas, 
063
064   
065
066                        @Description(shortDefinition="The ID of the resource")
067                        @OptionalParam(name="_id")
068                        TokenAndListParam the_id,
069   
070
071                        @Description(shortDefinition="Only return resources which were last updated as specified by the given range")
072                        @OptionalParam(name="_lastUpdated")
073                        DateRangeParam the_lastUpdated, 
074   
075
076                        @Description(shortDefinition="The profile of the resource")
077                        @OptionalParam(name="_profile")
078                        UriAndListParam the_profile, 
079   
080
081                        @Description(shortDefinition="The security of the resource")
082                        @OptionalParam(name="_security")
083                        TokenAndListParam the_security,
084   
085
086                        @Description(shortDefinition="The tag of the resource")
087                        @OptionalParam(name="_tag")
088                        TokenAndListParam the_tag,
089   
090
091                        @Description(shortDefinition="Search on the narrative of the resource")
092                        @OptionalParam(name="_text")
093                        SpecialAndListParam the_text,
094   
095
096                        @Description(shortDefinition="The type of specimen conditioned in container expected by the lab")
097                        @OptionalParam(name="container")
098                        TokenAndListParam theContainer,
099   
100
101                        @Description(shortDefinition="Not for genuine usage (true)")
102                        @OptionalParam(name="experimental")
103                        TokenAndListParam theExperimental,
104   
105
106                        @Description(shortDefinition="Multiple Resources: * [ActivityDefinition](activitydefinition.html): External identifier for the activity definition* [ActorDefinition](actordefinition.html): External identifier for the Actor Definition* [CapabilityStatement](capabilitystatement.html): External identifier for the capability statement* [ChargeItemDefinition](chargeitemdefinition.html): External identifier for the charge item definition* [Citation](citation.html): External identifier for the citation* [CodeSystem](codesystem.html): External identifier for the code system* [ConceptMap](conceptmap.html): External identifier for the concept map* [ConditionDefinition](conditiondefinition.html): External identifier for the condition definition* [EventDefinition](eventdefinition.html): External identifier for the event definition* [Evidence](evidence.html): External identifier for the evidence* [EvidenceReport](evidencereport.html): External identifier for the evidence report* [EvidenceVariable](evidencevariable.html): External identifier for the evidence variable* [ExampleScenario](examplescenario.html): External identifier for the example scenario* [GraphDefinition](graphdefinition.html): External identifier for the graph definition* [ImplementationGuide](implementationguide.html): External identifier for the implementation guide* [Library](library.html): External identifier for the library* [Measure](measure.html): External identifier for the measure* [MedicationKnowledge](medicationknowledge.html): Business identifier for this medication* [MessageDefinition](messagedefinition.html): External identifier for the message definition* [NamingSystem](namingsystem.html): External identifier for the naming system* [ObservationDefinition](observationdefinition.html): The unique identifier associated with the specimen definition* [OperationDefinition](operationdefinition.html): External identifier for the search parameter* [PlanDefinition](plandefinition.html): External identifier for the plan definition* [Questionnaire](questionnaire.html): External identifier for the questionnaire* [Requirements](requirements.html): External identifier for the requirements* [SearchParameter](searchparameter.html): External identifier for the search parameter* [SpecimenDefinition](specimendefinition.html): The unique identifier associated with the SpecimenDefinition* [StructureDefinition](structuredefinition.html): External identifier for the structure definition* [StructureMap](structuremap.html): External identifier for the structure map* [SubscriptionTopic](subscriptiontopic.html): Business Identifier for SubscriptionTopic* [TerminologyCapabilities](terminologycapabilities.html): External identifier for the terminology capabilities* [TestPlan](testplan.html): An identifier for the test plan* [TestScript](testscript.html): External identifier for the test script* [ValueSet](valueset.html): External identifier for the value set")
107                        @OptionalParam(name="identifier")
108                        TokenAndListParam theIdentifier,
109   
110
111                        @Description(shortDefinition="Primary specimen (false) or derived specimen (true)")
112                        @OptionalParam(name="is-derived")
113                        TokenAndListParam theIs_derived,
114   
115
116                        @Description(shortDefinition="Multiple Resources: * [ActivityDefinition](activitydefinition.html): The current status of the activity definition* [ActorDefinition](actordefinition.html): The current status of the Actor Definition* [CapabilityStatement](capabilitystatement.html): The current status of the capability statement* [ChargeItemDefinition](chargeitemdefinition.html): The current status of the charge item definition* [Citation](citation.html): The current status of the citation* [CodeSystem](codesystem.html): The current status of the code system* [CompartmentDefinition](compartmentdefinition.html): The current status of the compartment definition* [ConceptMap](conceptmap.html): The current status of the concept map* [ConditionDefinition](conditiondefinition.html): The current status of the condition definition* [EventDefinition](eventdefinition.html): The current status of the event definition* [Evidence](evidence.html): The current status of the evidence* [EvidenceReport](evidencereport.html): The current status of the evidence report* [EvidenceVariable](evidencevariable.html): The current status of the evidence variable* [ExampleScenario](examplescenario.html): The current status of the example scenario* [GraphDefinition](graphdefinition.html): The current status of the graph definition* [ImplementationGuide](implementationguide.html): The current status of the implementation guide* [Library](library.html): The current status of the library* [Measure](measure.html): The current status of the measure* [MedicationKnowledge](medicationknowledge.html): active | inactive | entered-in-error* [MessageDefinition](messagedefinition.html): The current status of the message definition* [NamingSystem](namingsystem.html): The current status of the naming system* [ObservationDefinition](observationdefinition.html): Publication status of the ObservationDefinition: draft, active, retired, unknown* [OperationDefinition](operationdefinition.html): The current status of the operation definition* [PlanDefinition](plandefinition.html): The current status of the plan definition* [Questionnaire](questionnaire.html): The current status of the questionnaire* [Requirements](requirements.html): The current status of the requirements* [SearchParameter](searchparameter.html): The current status of the search parameter* [SpecimenDefinition](specimendefinition.html): Publication status of the SpecimenDefinition: draft, active, retired, unknown* [StructureDefinition](structuredefinition.html): The current status of the structure definition* [StructureMap](structuremap.html): The current status of the structure map* [SubscriptionTopic](subscriptiontopic.html): draft | active | retired | unknown* [TerminologyCapabilities](terminologycapabilities.html): The current status of the terminology capabilities* [TestPlan](testplan.html): The current status of the test plan* [TestScript](testscript.html): The current status of the test script* [ValueSet](valueset.html): The current status of the value set")
117                        @OptionalParam(name="status")
118                        TokenAndListParam theStatus,
119   
120
121                        @Description(shortDefinition="Multiple Resources: * [ActivityDefinition](activitydefinition.html): The human-friendly name of the activity definition* [ActorDefinition](actordefinition.html): The human-friendly name of the Actor Definition* [CapabilityStatement](capabilitystatement.html): The human-friendly name of the capability statement* [ChargeItemDefinition](chargeitemdefinition.html): The human-friendly name of the charge item definition* [Citation](citation.html): The human-friendly name of the citation* [CodeSystem](codesystem.html): The human-friendly name of the code system* [ConceptMap](conceptmap.html): The human-friendly name of the concept map* [ConditionDefinition](conditiondefinition.html): The human-friendly name of the condition definition* [EventDefinition](eventdefinition.html): The human-friendly name of the event definition* [Evidence](evidence.html): The human-friendly name of the evidence* [EvidenceVariable](evidencevariable.html): The human-friendly name of the evidence variable* [ImplementationGuide](implementationguide.html): The human-friendly name of the implementation guide* [Library](library.html): The human-friendly name of the library* [Measure](measure.html): The human-friendly name of the measure* [MessageDefinition](messagedefinition.html): The human-friendly name of the message definition* [ObservationDefinition](observationdefinition.html): Human-friendly name of the ObservationDefinition* [OperationDefinition](operationdefinition.html): The human-friendly name of the operation definition* [PlanDefinition](plandefinition.html): The human-friendly name of the plan definition* [Questionnaire](questionnaire.html): The human-friendly name of the questionnaire* [Requirements](requirements.html): The human-friendly name of the requirements* [SpecimenDefinition](specimendefinition.html): Human-friendly name of the SpecimenDefinition* [StructureDefinition](structuredefinition.html): The human-friendly name of the structure definition* [StructureMap](structuremap.html): The human-friendly name of the structure map* [SubscriptionTopic](subscriptiontopic.html): Name for this SubscriptionTopic (Human friendly)* [TerminologyCapabilities](terminologycapabilities.html): The human-friendly name of the terminology capabilities* [TestScript](testscript.html): The human-friendly name of the test script* [ValueSet](valueset.html): The human-friendly name of the value set")
122                        @OptionalParam(name="title")
123                        StringAndListParam theTitle, 
124   
125
126                        @Description(shortDefinition="The type of collected specimen")
127                        @OptionalParam(name="type")
128                        TokenAndListParam theType,
129   
130
131                        @Description(shortDefinition="The type of specimen conditioned for testing")
132                        @OptionalParam(name="type-tested")
133                        TokenAndListParam theType_tested,
134   
135
136                        @Description(shortDefinition="Multiple Resources: * [ActivityDefinition](activitydefinition.html): The uri that identifies the activity definition* [ActorDefinition](actordefinition.html): The uri that identifies the Actor Definition* [CapabilityStatement](capabilitystatement.html): The uri that identifies the capability statement* [ChargeItemDefinition](chargeitemdefinition.html): The uri that identifies the charge item definition* [Citation](citation.html): The uri that identifies the citation* [CodeSystem](codesystem.html): The uri that identifies the code system* [CompartmentDefinition](compartmentdefinition.html): The uri that identifies the compartment definition* [ConceptMap](conceptmap.html): The URI that identifies the concept map* [ConditionDefinition](conditiondefinition.html): The uri that identifies the condition definition* [EventDefinition](eventdefinition.html): The uri that identifies the event definition* [Evidence](evidence.html): The uri that identifies the evidence* [EvidenceReport](evidencereport.html): The uri that identifies the evidence report* [EvidenceVariable](evidencevariable.html): The uri that identifies the evidence variable* [ExampleScenario](examplescenario.html): The uri that identifies the example scenario* [GraphDefinition](graphdefinition.html): The uri that identifies the graph definition* [ImplementationGuide](implementationguide.html): The uri that identifies the implementation guide* [Library](library.html): The uri that identifies the library* [Measure](measure.html): The uri that identifies the measure* [MessageDefinition](messagedefinition.html): The uri that identifies the message definition* [NamingSystem](namingsystem.html): The uri that identifies the naming system* [ObservationDefinition](observationdefinition.html): The uri that identifies the observation definition* [OperationDefinition](operationdefinition.html): The uri that identifies the operation definition* [PlanDefinition](plandefinition.html): The uri that identifies the plan definition* [Questionnaire](questionnaire.html): The uri that identifies the questionnaire* [Requirements](requirements.html): The uri that identifies the requirements* [SearchParameter](searchparameter.html): The uri that identifies the search parameter* [SpecimenDefinition](specimendefinition.html): The uri that identifies the specimen definition* [StructureDefinition](structuredefinition.html): The uri that identifies the structure definition* [StructureMap](structuremap.html): The uri that identifies the structure map* [SubscriptionTopic](subscriptiontopic.html): Logical canonical URL to reference this SubscriptionTopic (globally unique)* [TerminologyCapabilities](terminologycapabilities.html): The uri that identifies the terminology capabilities* [TestPlan](testplan.html): The uri that identifies the test plan* [TestScript](testscript.html): The uri that identifies the test script* [ValueSet](valueset.html): The uri that identifies the value set")
137                        @OptionalParam(name="url")
138                        UriAndListParam theUrl, 
139
140                        @RawParam
141                        Map<String, List<String>> theAdditionalRawParams,
142
143        
144                        @IncludeParam
145                        Set<Include> theIncludes,
146
147                        @IncludeParam(reverse=true)
148                        Set<Include> theRevIncludes,
149
150                        @Sort
151                        SortSpec theSort,
152                        
153                        @ca.uhn.fhir.rest.annotation.Count
154                        Integer theCount,
155
156                        @ca.uhn.fhir.rest.annotation.Offset
157                        Integer theOffset,
158
159                        SummaryEnum theSummaryMode,
160
161                        SearchTotalModeEnum theSearchTotalMode,
162
163                        SearchContainedModeEnum theSearchContainedMode
164
165                        ) {
166                startRequest(theServletRequest);
167                try {
168                        SearchParameterMap paramMap = new SearchParameterMap();
169                        paramMap.add(ca.uhn.fhir.rest.api.Constants.PARAM_FILTER, theFtFilter);
170                        paramMap.add(ca.uhn.fhir.rest.api.Constants.PARAM_CONTENT, theFtContent);
171                        paramMap.add(ca.uhn.fhir.rest.api.Constants.PARAM_TEXT, theFtText);
172                        paramMap.add(ca.uhn.fhir.rest.api.Constants.PARAM_SOURCE, theSearchForSource);
173                        paramMap.add(ca.uhn.fhir.rest.api.Constants.PARAM_LIST, theList);
174                        paramMap.add(ca.uhn.fhir.rest.api.Constants.PARAM_LANGUAGE, theResourceLanguage);
175
176                        paramMap.add("_has", theHas);
177                                paramMap.add("_id", the_id);
178                                                                paramMap.add("_profile", the_profile);
179                                paramMap.add("_security", the_security);
180                                paramMap.add("_tag", the_tag);
181                                paramMap.add("_text", the_text);
182                                paramMap.add("container", theContainer);
183                                paramMap.add("experimental", theExperimental);
184                                paramMap.add("identifier", theIdentifier);
185                                paramMap.add("is-derived", theIs_derived);
186                                paramMap.add("status", theStatus);
187                                paramMap.add("title", theTitle);
188                                paramMap.add("type", theType);
189                                paramMap.add("type-tested", theType_tested);
190                                paramMap.add("url", theUrl);
191paramMap.setRevIncludes(theRevIncludes);
192                        paramMap.setLastUpdated(the_lastUpdated);
193                        paramMap.setIncludes(theIncludes);
194                        paramMap.setSort(theSort);
195                        paramMap.setCount(theCount);
196                        paramMap.setOffset(theOffset);
197                        paramMap.setSummaryMode(theSummaryMode);
198                        paramMap.setSearchTotalMode(theSearchTotalMode);
199                        paramMap.setSearchContainedMode(theSearchContainedMode);
200
201                        getDao().translateRawParameters(theAdditionalRawParams, paramMap);
202
203                        ca.uhn.fhir.rest.api.server.IBundleProvider retVal = getDao().search(paramMap, theRequestDetails, theServletResponse);
204                        return retVal;
205                } finally {
206                        endRequest(theServletRequest);
207                }
208        }
209
210}