Package ca.uhn.fhir.rest.server.interceptor.auth

Interface IAuthRuleBuilderRuleOpClassifier

public interface IAuthRuleBuilderRuleOpClassifier

  • Method Details

    • inCompartment

      IAuthRuleBuilderRuleOpClassifierFinished inCompartment(String theCompartmentName, org.hl7.fhir.instance.model.api.IIdType theOwner)
      Rule applies to resources in the given compartment.

      For example, to apply the rule to any observations in the patient compartment belonging to patient "123", you would invoke this with
      inCompartment("Patient", new IdType("Patient", "123"))

      This call completes the rule and adds the rule to the chain.

      Parameters:
      theCompartmentName - The name of the compartment (must not be null or blank)
      theOwner - The owner of the compartment. Note that both the resource type and ID must be populated in this ID.

    • inCompartmentWithAdditionalSearchParams

      IAuthRuleBuilderRuleOpClassifierFinished inCompartmentWithAdditionalSearchParams(String theCompartmentName, org.hl7.fhir.instance.model.api.IIdType theOwner, AdditionalCompartmentSearchParameters theAdditionalTypeSearchParamNames)
      Rule applies to resources in the given compartment.

      For example, to apply the rule to any observations in the patient compartment belonging to patient "123", you would invoke this with
      inCompartment("Patient", new IdType("Patient", "123")) This call also allows you to pass additional search parameters that count as being included in the given compartment, passed in as a list of `resourceType:search-parameter-name`. For example, if you select a compartment name of "patient", you could pass in a singleton list consisting of the string "device:patient", which would cause any devices belonging to the patient to be permitted by the authorization rule.

      This call completes the rule and adds the rule to the chain.

      Parameters:
      theCompartmentName - The name of the compartment (must not be null or blank)
      theOwner - The owner of the compartment. Note that both the resource type and ID must be populated in this ID.
      theAdditionalTypeSearchParamNames - A list of strings for additional resource types and search parameters which count as being in the compartment, in the form "resourcetype:search-parameter-name".

    • inCompartment

      IAuthRuleBuilderRuleOpClassifierFinished inCompartment(String theCompartmentName, Collection<? extends org.hl7.fhir.instance.model.api.IIdType> theOwners)
      Rule applies to resources in the given compartment.

      For example, to apply the rule to any observations in the patient compartment belonging to patient "123", you would invoke this with
      inCompartment("Patient", new IdType("Patient", "123"))

      This call completes the rule and adds the rule to the chain.

      Parameters:
      theCompartmentName - The name of the compartment (must not be null or blank)
      theOwners - The owner of the compartment. Note that both the resource type and ID must be populated in this ID.

    • inCompartmentWithAdditionalSearchParams

      IAuthRuleBuilderRuleOpClassifierFinished inCompartmentWithAdditionalSearchParams(String theCompartmentName, Collection<? extends org.hl7.fhir.instance.model.api.IIdType> theOwners, AdditionalCompartmentSearchParameters theAdditionalTypeSearchParamNames)
      Rule applies to resources in the given compartment.

      For example, to apply the rule to any observations in the patient compartment belonging to patient "123", you would invoke this with
      inCompartment("Patient", new IdType("Patient", "123")) This call also allows you to pass additional search parameters that count as being included in the given compartment, passed in as a list of `resourceType:search-parameter-name`. For example, if you select a compartment name of "patient", you could pass in a singleton list consisting of the string "device:patient", which would cause any devices belonging to the patient to be permitted by the authorization rule.

      This call completes the rule and adds the rule to the chain.

      Parameters:
      theCompartmentName - The name of the compartment (must not be null or blank)
      theOwners - The owners of the compartment. Note that both the resource type and ID must be populated in these IDs.
      theAdditionalTypeSearchParamNames - A AdditionalCompartmentSearchParameters which allows you to expand the search space for what is considered "in" the compartment.

    • withAnyId

      IAuthRuleBuilderRuleOpClassifierFinished withAnyId()
      Rule applies to any resource instances

      This call completes the rule and adds the rule to the chain.

    • withCodeInValueSet

      IAuthRuleBuilderRuleOpClassifierFinished withCodeInValueSet(@Nonnull String theSearchParameterName, @Nonnull String theValueSetUrl)
      Rule applies to resources where the given search parameter would be satisfied by a code in the given ValueSet
      Parameters:
      theSearchParameterName - The search parameter name, e.g. "code"
      theValueSetUrl - The valueset URL, e.g. "http://my-value-set"
      Since:
      6.0.0

    • withCodeNotInValueSet

      IAuthRuleFinished withCodeNotInValueSet(@Nonnull String theSearchParameterName, @Nonnull String theValueSetUrl)
      Rule applies to resources where the given search parameter would be satisfied by a code not in the given ValueSet
      Parameters:
      theSearchParameterName - The search parameter name, e.g. "code"
      theValueSetUrl - The valueset URL, e.g. "http://my-value-set"
      Since:
      6.0.0

    • inCompartmentWithFilter

      IAuthRuleFinished inCompartmentWithFilter(String theCompartment, org.hl7.fhir.instance.model.api.IIdType theIdElement, String theFilter)

    • withFilter

      IAuthRuleFinished withFilter(String theFilter)