Package ca.uhn.fhir.rest.annotation

Annotation Type IncludeParam

@Retention(RUNTIME) @Target(PARAMETER) public @interface IncludeParam
Method parameter which is used to indicate a parameter that will be populated with the "_include" (or "_revinclude") values for a search param. The parameter annotated with this annotation is used for either "_include" or "_revinclude", depending on whether reverse() has been set to true (default is false).

Only up to two parameters may be annotated with this annotation (one each for reverse=false and reverse=true. That parameter should be one of the following:

  • Collection<Include>
  • List<Include>
  • Set<Include>
See Also:

  • Optional Element Summary

    Optional Elements
    Modifier and Type
    Optional Element
    Description
    String[]
    allow
    Optional value, if provided the server will only allow the values within the given set.
    boolean
    reverse
    If set to true (default is false), the values for this parameter correspond to the _revinclude parameter instead of the _include parameter.

  • Element Details

    • allow

      String[] allow
      Optional value, if provided the server will only allow the values within the given set. If an _include parameter is passed to the server which does not match any allowed values the server will return an error.

      Values for this parameter take the form that the FHIR specification defines for _include values, namely [Resource Name].[path]. For example: "Patient.link.other" or "Encounter.partOf"

      You may also pass in a value of "*" which indicates means that the client may request _include=*. This is a request to include all referenced resources as well as any resources referenced by those resources, etc.

      Leave this parameter empty if you do not want the server to declare or restrict which includes are allowable. In this case, the client may add any _include value they want, and that value will be accepted by the server and passed to the handling method. Note that this means that the server will not declare which _include values it supports in its conformance statement.

      Default:
      {}

    • reverse

      boolean reverse
      If set to true (default is false), the values for this parameter correspond to the _revinclude parameter instead of the _include parameter.
      Default:
      false