Document potential issues if compartment inclusion criteria search parms are not in tenant's configured search parm list

[michaelwschroeder]

Is your feature request related to a problem? Please describe.
If compartment inclusion criteria search parameters are not specified in the fhirServer/resources/<resourceType>/searchParameters list for a given resource type, then the new generated compartment search token (if the fhirServer/search/useStoredCompartmentParam value is set to true - see issue #1708) or the tokens for the inclusion criteria search parameters, are not created/stored at resource create/update time, and thus that resource will not get returned on a compartment search as it should.

Example:

1. fhir-server-config.json only specifies _id and _lastUpdated as valid search parameters for the Procedure resource type, not the patient and performer inclusion criteria search parameters:

       "resources": {
         "Procedure": {
           "searchParameters": {
             "_id": "http://hl7.org/fhir/SearchParameter/Resource-id",
             "_lastUpdated": "http://hl7.org/fhir/SearchParameter/Resource-lastUpdated"
           }
         }
       },
   

2. A Procedure resource is created which contains the following Patient reference, meaning it should be associated with that Patient compartment:

       "subject": {
         "reference": "Patient/17575"
       },
   

   However, the Patient compartment inclusion criteria search parameters for the Procedure resource type, patient and performer, are not in the fhirServer/resources/<resourceType>/searchParameters list, so are not considered valid search parameters. This means the generated compartment search token (if enabled) or the inclusion criteria search tokens will not be created and indexed when the Procedure resource is stored.

3. The following compartment search is performed:

   Patient/17575/Procedure
   

   The Procedure created in step 2 will not be returned in the search results because the necessary compartment search token(s), which are what's used in the compartment search SQL, were not created and indexed.

This should be clearly documented.

Describe the solution you'd like
See issue #1777 for the desired solution.

Describe alternatives you've considered
See issue #1707 for alternative solutions considered.

Acceptance Criteria
At least one acceptance criteria is included.

GIVEN [a precondition]
AND [another precondition] WHEN [test step]
AND [test step]
THEN [verification step]
AND [verification step]

Additional context
Add any other context or screenshots about the feature request here.