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 DocumentReferenceResourceProvider extends 020 ca.uhn.fhir.jpa.provider.BaseJpaResourceProvider<DocumentReference> 021 { 022 023 @Override 024 public Class<DocumentReference> getResourceType() { 025 return DocumentReference.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="Who attested the document") 085 @OptionalParam(name="attester", targetTypes={ } ) 086 ReferenceAndListParam theAttester, 087 088 089 @Description(shortDefinition="Who and/or what authored the document") 090 @OptionalParam(name="author", targetTypes={ } ) 091 ReferenceAndListParam theAuthor, 092 093 094 @Description(shortDefinition="Procedure that caused this media to be created") 095 @OptionalParam(name="based-on", targetTypes={ } ) 096 ReferenceAndListParam theBased_on, 097 098 099 @Description(shortDefinition="The body site studied") 100 @OptionalParam(name="bodysite") 101 TokenAndListParam theBodysite, 102 103 104 @Description(shortDefinition="The body site studied") 105 @OptionalParam(name="bodysite-reference", targetTypes={ } ) 106 ReferenceAndListParam theBodysite_reference, 107 108 109 @Description(shortDefinition="Categorization of document") 110 @OptionalParam(name="category") 111 TokenAndListParam theCategory, 112 113 114 @Description(shortDefinition="Mime type of the content, with charset etc.") 115 @OptionalParam(name="contenttype") 116 TokenAndListParam theContenttype, 117 118 119 @Description(shortDefinition="Context of the document content") 120 @OptionalParam(name="context", targetTypes={ } ) 121 ReferenceAndListParam theContext, 122 123 124 @Description(shortDefinition="Date attachment was first created") 125 @OptionalParam(name="creation") 126 DateRangeParam theCreation, 127 128 129 @Description(shortDefinition="Organization which maintains the document") 130 @OptionalParam(name="custodian", targetTypes={ } ) 131 ReferenceAndListParam theCustodian, 132 133 134 @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") 135 @OptionalParam(name="date") 136 DateRangeParam theDate, 137 138 139 @Description(shortDefinition="Human-readable description") 140 @OptionalParam(name="description") 141 StringAndListParam theDescription, 142 143 144 @Description(shortDefinition="preliminary | final | amended | entered-in-error") 145 @OptionalParam(name="doc-status") 146 TokenAndListParam theDoc_status, 147 148 149 @Description(shortDefinition="Main clinical acts documented") 150 @OptionalParam(name="event-code") 151 TokenAndListParam theEvent_code, 152 153 154 @Description(shortDefinition="Main clinical acts documented") 155 @OptionalParam(name="event-reference", targetTypes={ } ) 156 ReferenceAndListParam theEvent_reference, 157 158 159 @Description(shortDefinition="Kind of facility where patient was seen") 160 @OptionalParam(name="facility") 161 TokenAndListParam theFacility, 162 163 164 @Description(shortDefinition="Profile canonical content rules for the document") 165 @OptionalParam(name="format-canonical", targetTypes={ } ) 166 ReferenceAndListParam theFormat_canonical, 167 168 169 @Description(shortDefinition="Format code content rules for the document") 170 @OptionalParam(name="format-code") 171 TokenAndListParam theFormat_code, 172 173 174 @Description(shortDefinition="Profile URI content rules for the document") 175 @OptionalParam(name="format-uri") 176 UriAndListParam theFormat_uri, 177 178 179 @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") 180 @OptionalParam(name="identifier") 181 TokenAndListParam theIdentifier, 182 183 184 @Description(shortDefinition="Human language of the content (BCP-47)") 185 @OptionalParam(name="language") 186 TokenAndListParam theLanguage, 187 188 189 @Description(shortDefinition="Uri where the data can be found") 190 @OptionalParam(name="location") 191 UriAndListParam theLocation, 192 193 194 @Description(shortDefinition="The modality used") 195 @OptionalParam(name="modality") 196 TokenAndListParam theModality, 197 198 199 @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") 200 @OptionalParam(name="patient", targetTypes={ } ) 201 ReferenceAndListParam thePatient, 202 203 204 @Description(shortDefinition="Time of service that is being documented") 205 @OptionalParam(name="period") 206 DateRangeParam thePeriod, 207 208 209 @Description(shortDefinition="Target of the relationship") 210 @OptionalParam(name="relatesto", targetTypes={ } ) 211 ReferenceAndListParam theRelatesto, 212 213 214 @Description(shortDefinition="replaces | transforms | signs | appends") 215 @OptionalParam(name="relation") 216 TokenAndListParam theRelation, 217 218 219 @Description(shortDefinition="Combination of relation and relatesTo") 220 @OptionalParam(name="relationship", compositeTypes= { ReferenceParam.class, TokenParam.class }) 221 CompositeAndListParam<ReferenceParam, TokenParam> theRelationship, 222 223 224 @Description(shortDefinition="Document security-tags") 225 @OptionalParam(name="security-label") 226 TokenAndListParam theSecurity_label, 227 228 229 @Description(shortDefinition="Additional details about where the content was created (e.g. clinical specialty)") 230 @OptionalParam(name="setting") 231 TokenAndListParam theSetting, 232 233 234 @Description(shortDefinition="current | superseded | entered-in-error") 235 @OptionalParam(name="status") 236 TokenAndListParam theStatus, 237 238 239 @Description(shortDefinition="Who/what is the subject of the document") 240 @OptionalParam(name="subject", targetTypes={ } ) 241 ReferenceAndListParam theSubject, 242 243 244 @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") 245 @OptionalParam(name="type") 246 TokenAndListParam theType, 247 248 249 @Description(shortDefinition="The business version identifier") 250 @OptionalParam(name="version") 251 StringAndListParam theVersion, 252 253 @RawParam 254 Map<String, List<String>> theAdditionalRawParams, 255 256 @Description(shortDefinition="Only return resources which were last updated as specified by the given range") 257 @OptionalParam(name="_lastUpdated") 258 DateRangeParam theLastUpdated, 259 260 @IncludeParam 261 Set<Include> theIncludes, 262 263 @IncludeParam(reverse=true) 264 Set<Include> theRevIncludes, 265 266 @Sort 267 SortSpec theSort, 268 269 @ca.uhn.fhir.rest.annotation.Count 270 Integer theCount, 271 272 @ca.uhn.fhir.rest.annotation.Offset 273 Integer theOffset, 274 275 SummaryEnum theSummaryMode, 276 277 SearchTotalModeEnum theSearchTotalMode, 278 279 SearchContainedModeEnum theSearchContainedMode 280 281 ) { 282 startRequest(theServletRequest); 283 try { 284 SearchParameterMap paramMap = new SearchParameterMap(); 285 paramMap.add(ca.uhn.fhir.rest.api.Constants.PARAM_FILTER, theFtFilter); 286 paramMap.add(ca.uhn.fhir.rest.api.Constants.PARAM_CONTENT, theFtContent); 287 paramMap.add(ca.uhn.fhir.rest.api.Constants.PARAM_TEXT, theFtText); 288 paramMap.add(ca.uhn.fhir.rest.api.Constants.PARAM_TAG, theSearchForTag); 289 paramMap.add(ca.uhn.fhir.rest.api.Constants.PARAM_SECURITY, theSearchForSecurity); 290 paramMap.add(ca.uhn.fhir.rest.api.Constants.PARAM_PROFILE, theSearchForProfile); 291 paramMap.add(ca.uhn.fhir.rest.api.Constants.PARAM_SOURCE, theSearchForSource); 292 paramMap.add(ca.uhn.fhir.rest.api.Constants.PARAM_LIST, theList); 293 paramMap.add("_has", theHas); 294 paramMap.add("_id", the_id); 295 paramMap.add("_text", the_text); 296 paramMap.add("attester", theAttester); 297 paramMap.add("author", theAuthor); 298 paramMap.add("based-on", theBased_on); 299 paramMap.add("bodysite", theBodysite); 300 paramMap.add("bodysite-reference", theBodysite_reference); 301 paramMap.add("category", theCategory); 302 paramMap.add("contenttype", theContenttype); 303 paramMap.add("context", theContext); 304 paramMap.add("creation", theCreation); 305 paramMap.add("custodian", theCustodian); 306 paramMap.add("date", theDate); 307 paramMap.add("description", theDescription); 308 paramMap.add("doc-status", theDoc_status); 309 paramMap.add("event-code", theEvent_code); 310 paramMap.add("event-reference", theEvent_reference); 311 paramMap.add("facility", theFacility); 312 paramMap.add("format-canonical", theFormat_canonical); 313 paramMap.add("format-code", theFormat_code); 314 paramMap.add("format-uri", theFormat_uri); 315 paramMap.add("identifier", theIdentifier); 316 paramMap.add("language", theLanguage); 317 paramMap.add("location", theLocation); 318 paramMap.add("modality", theModality); 319 paramMap.add("patient", thePatient); 320 paramMap.add("period", thePeriod); 321 paramMap.add("relatesto", theRelatesto); 322 paramMap.add("relation", theRelation); 323 paramMap.add("relationship", theRelationship); 324 paramMap.add("security-label", theSecurity_label); 325 paramMap.add("setting", theSetting); 326 paramMap.add("status", theStatus); 327 paramMap.add("subject", theSubject); 328 paramMap.add("type", theType); 329 paramMap.add("version", theVersion); 330 paramMap.setRevIncludes(theRevIncludes); 331 paramMap.setLastUpdated(theLastUpdated); 332 paramMap.setIncludes(theIncludes); 333 paramMap.setSort(theSort); 334 paramMap.setCount(theCount); 335 paramMap.setOffset(theOffset); 336 paramMap.setSummaryMode(theSummaryMode); 337 paramMap.setSearchTotalMode(theSearchTotalMode); 338 paramMap.setSearchContainedMode(theSearchContainedMode); 339 340 getDao().translateRawParameters(theAdditionalRawParams, paramMap); 341 342 ca.uhn.fhir.rest.api.server.IBundleProvider retVal = getDao().search(paramMap, theRequestDetails, theServletResponse); 343 return retVal; 344 } finally { 345 endRequest(theServletRequest); 346 } 347 } 348 349}