Class CapabilityStatement.CapabilityStatementRestResourceSearchParamComponent

All Implemented Interfaces:
ca.uhn.fhir.model.api.IElement, Serializable, org.hl7.fhir.instance.model.api.IBase, org.hl7.fhir.instance.model.api.IBaseBackboneElement, org.hl7.fhir.instance.model.api.IBaseElement, org.hl7.fhir.instance.model.api.IBaseHasExtensions, org.hl7.fhir.instance.model.api.IBaseHasModifierExtensions
Enclosing class:

public static class CapabilityStatement.CapabilityStatementRestResourceSearchParamComponent extends BackboneElement implements org.hl7.fhir.instance.model.api.IBaseBackboneElement
See Also:
  • Field Details

    • name

      protected StringType name
      The label used for the search parameter in this particular system's API - i.e. the 'name' portion of the name-value pair that will appear as part of the search URL. This SHOULD be the same as the SearchParameter.code of the defining SearchParameter. However, it can sometimes differ if necessary to disambiguate when a server supports multiple SearchParameters that happen to share the same code.
    • definition

      An absolute URI that is a formal reference to where this parameter was first defined, so that a client can be confident of the meaning of the search parameter (a reference to [SearchParameter.url](searchparameter-definitions.html#SearchParameter.url)). This element SHALL be populated if the search parameter refers to a SearchParameter defined by the FHIR core specification or externally defined IGs.
    • type

      The type of value a search parameter refers to, and how the content is interpreted.
    • documentation

      This allows documentation of any distinct behaviors about how the search parameter is used. For example, text matching algorithms.
  • Constructor Details

  • Method Details