Class OperationDefinition

All Implemented Interfaces:
ca.uhn.fhir.model.api.IElement, Serializable, org.hl7.fhir.instance.model.api.IAnyResource, org.hl7.fhir.instance.model.api.IBase, org.hl7.fhir.instance.model.api.IBaseHasExtensions, org.hl7.fhir.instance.model.api.IBaseHasModifierExtensions, org.hl7.fhir.instance.model.api.IBaseResource, org.hl7.fhir.instance.model.api.IDomainResource

A formal computable definition of an operation (on the RESTful interface) or a named query (using the search interaction).
See Also:
  • Field Details

    • kind

      Whether this is an operation or a named query.
    • purpose

      protected MarkdownType purpose
      Explanation of why this operation definition is needed and why it has been designed as it has.
    • affectsState

      Whether the operation affects state. Side effects such as producing audit trail entries do not count as 'affecting state'.
    • code

      protected CodeType code
      The name used to invoke the operation.
    • comment

      protected MarkdownType comment
      Additional information about how to use this operation or named query.
    • base

      protected CanonicalType base
      Indicates that this operation definition is a constraining profile on the base.
    • resource

      protected List<CodeType> resource
      The types on which this operation can be executed.
    • system

      protected BooleanType system
      Indicates whether this operation or named query can be invoked at the system level (e.g. without needing to choose a resource type for the context).
    • type

      protected BooleanType type
      Indicates whether this operation or named query can be invoked at the resource type level for any given resource type level (e.g. without needing to choose a specific resource id for the context).
    • instance

      protected BooleanType instance
      Indicates whether this operation can be invoked on a particular instance of one of the given types.
    • inputProfile

      Additional validation information for the in parameters - a single profile that covers all the parameters. The profile is a constraint on the parameters resource as a whole.
    • outputProfile

      Additional validation information for the out parameters - a single profile that covers all the parameters. The profile is a constraint on the parameters resource.
    • parameter

      The parameters for the operation/query.
    • overload

      Defines an appropriate combination of parameters to use when invoking this operation, to help code generators when generating overloaded parameter sets for this operation.
    • SP_DATE

      public static final String SP_DATE
      Search parameter: date

      Description: The operation definition publication date
      Type: date
      Path: OperationDefinition.date

      See Also:
    • DATE

      public static final ca.uhn.fhir.rest.gclient.DateClientParam DATE
      Fluent Client search parameter constant for date

      Description: The operation definition publication date
      Type: date
      Path: OperationDefinition.date

    • SP_CODE

      public static final String SP_CODE
      Search parameter: code

      Description: Name used to invoke the operation
      Type: token
      Path: OperationDefinition.code

      See Also:
    • CODE

      public static final ca.uhn.fhir.rest.gclient.TokenClientParam CODE
      Fluent Client search parameter constant for code

      Description: Name used to invoke the operation
      Type: token
      Path: OperationDefinition.code

    • SP_INSTANCE

      public static final String SP_INSTANCE
      Search parameter: instance

      Description: Invoke on an instance?
      Type: token
      Path: OperationDefinition.instance

      See Also:
    • INSTANCE

      public static final ca.uhn.fhir.rest.gclient.TokenClientParam INSTANCE
      Fluent Client search parameter constant for instance

      Description: Invoke on an instance?
      Type: token
      Path: OperationDefinition.instance

    • SP_CONTEXT_TYPE_VALUE

      public static final String SP_CONTEXT_TYPE_VALUE
      Search parameter: context-type-value

      Description: A use context type and value assigned to the operation definition
      Type: composite
      Path:

      See Also:
    • CONTEXT_TYPE_VALUE

      public static final ca.uhn.fhir.rest.gclient.CompositeClientParam<ca.uhn.fhir.rest.gclient.TokenClientParam,ca.uhn.fhir.rest.gclient.TokenClientParam> CONTEXT_TYPE_VALUE
      Fluent Client search parameter constant for context-type-value

      Description: A use context type and value assigned to the operation definition
      Type: composite
      Path:

    • SP_KIND

      public static final String SP_KIND
      Search parameter: kind

      Description: operation | query
      Type: token
      Path: OperationDefinition.kind

      See Also:
    • KIND

      public static final ca.uhn.fhir.rest.gclient.TokenClientParam KIND
      Fluent Client search parameter constant for kind

      Description: operation | query
      Type: token
      Path: OperationDefinition.kind

    • SP_JURISDICTION

      public static final String SP_JURISDICTION
      Search parameter: jurisdiction

      Description: Intended jurisdiction for the operation definition
      Type: token
      Path: OperationDefinition.jurisdiction

      See Also:
    • JURISDICTION

      public static final ca.uhn.fhir.rest.gclient.TokenClientParam JURISDICTION
      Fluent Client search parameter constant for jurisdiction

      Description: Intended jurisdiction for the operation definition
      Type: token
      Path: OperationDefinition.jurisdiction

    • SP_DESCRIPTION

      public static final String SP_DESCRIPTION
      Search parameter: description

      Description: The description of the operation definition
      Type: string
      Path: OperationDefinition.description

      See Also:
    • DESCRIPTION

      public static final ca.uhn.fhir.rest.gclient.StringClientParam DESCRIPTION
      Fluent Client search parameter constant for description

      Description: The description of the operation definition
      Type: string
      Path: OperationDefinition.description

    • SP_CONTEXT_TYPE

      public static final String SP_CONTEXT_TYPE
      Search parameter: context-type

      Description: A type of use context assigned to the operation definition
      Type: token
      Path: OperationDefinition.useContext.code

      See Also:
    • CONTEXT_TYPE

      public static final ca.uhn.fhir.rest.gclient.TokenClientParam CONTEXT_TYPE
      Fluent Client search parameter constant for context-type

      Description: A type of use context assigned to the operation definition
      Type: token
      Path: OperationDefinition.useContext.code

    • SP_TITLE

      public static final String SP_TITLE
      Search parameter: title

      Description: The human-friendly name of the operation definition
      Type: string
      Path: OperationDefinition.title

      See Also:
    • TITLE

      public static final ca.uhn.fhir.rest.gclient.StringClientParam TITLE
      Fluent Client search parameter constant for title

      Description: The human-friendly name of the operation definition
      Type: string
      Path: OperationDefinition.title

    • SP_TYPE

      public static final String SP_TYPE
      Search parameter: type

      Description: Invoke at the type level?
      Type: token
      Path: OperationDefinition.type

      See Also:
    • TYPE

      public static final ca.uhn.fhir.rest.gclient.TokenClientParam TYPE
      Fluent Client search parameter constant for type

      Description: Invoke at the type level?
      Type: token
      Path: OperationDefinition.type

    • SP_VERSION

      public static final String SP_VERSION
      Search parameter: version

      Description: The business version of the operation definition
      Type: token
      Path: OperationDefinition.version

      See Also:
    • VERSION

      public static final ca.uhn.fhir.rest.gclient.TokenClientParam VERSION
      Fluent Client search parameter constant for version

      Description: The business version of the operation definition
      Type: token
      Path: OperationDefinition.version

    • SP_URL

      public static final String SP_URL
      Search parameter: url

      Description: The uri that identifies the operation definition
      Type: uri
      Path: OperationDefinition.url

      See Also:
    • URL

      public static final ca.uhn.fhir.rest.gclient.UriClientParam URL
      Fluent Client search parameter constant for url

      Description: The uri that identifies the operation definition
      Type: uri
      Path: OperationDefinition.url

    • SP_CONTEXT_QUANTITY

      public static final String SP_CONTEXT_QUANTITY
      Search parameter: context-quantity

      Description: A quantity- or range-valued use context assigned to the operation definition
      Type: quantity
      Path: OperationDefinition.useContext.valueQuantity, OperationDefinition.useContext.valueRange

      See Also:
    • CONTEXT_QUANTITY

      public static final ca.uhn.fhir.rest.gclient.QuantityClientParam CONTEXT_QUANTITY
      Fluent Client search parameter constant for context-quantity

      Description: A quantity- or range-valued use context assigned to the operation definition
      Type: quantity
      Path: OperationDefinition.useContext.valueQuantity, OperationDefinition.useContext.valueRange

    • SP_INPUT_PROFILE

      public static final String SP_INPUT_PROFILE
      Search parameter: input-profile

      Description: Validation information for in parameters
      Type: reference
      Path: OperationDefinition.inputProfile

      See Also:
    • INPUT_PROFILE

      public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam INPUT_PROFILE
      Fluent Client search parameter constant for input-profile

      Description: Validation information for in parameters
      Type: reference
      Path: OperationDefinition.inputProfile

    • INCLUDE_INPUT_PROFILE

      public static final ca.uhn.fhir.model.api.Include INCLUDE_INPUT_PROFILE
      Constant for fluent queries to be used to add include statements. Specifies the path value of "OperationDefinition:input-profile".
    • SP_OUTPUT_PROFILE

      public static final String SP_OUTPUT_PROFILE
      Search parameter: output-profile

      Description: Validation information for out parameters
      Type: reference
      Path: OperationDefinition.outputProfile

      See Also:
    • OUTPUT_PROFILE

      public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam OUTPUT_PROFILE
      Fluent Client search parameter constant for output-profile

      Description: Validation information for out parameters
      Type: reference
      Path: OperationDefinition.outputProfile

    • INCLUDE_OUTPUT_PROFILE

      public static final ca.uhn.fhir.model.api.Include INCLUDE_OUTPUT_PROFILE
      Constant for fluent queries to be used to add include statements. Specifies the path value of "OperationDefinition:output-profile".
    • SP_SYSTEM

      public static final String SP_SYSTEM
      Search parameter: system

      Description: Invoke at the system level?
      Type: token
      Path: OperationDefinition.system

      See Also:
    • SYSTEM

      public static final ca.uhn.fhir.rest.gclient.TokenClientParam SYSTEM
      Fluent Client search parameter constant for system

      Description: Invoke at the system level?
      Type: token
      Path: OperationDefinition.system

    • SP_NAME

      public static final String SP_NAME
      Search parameter: name

      Description: Computationally friendly name of the operation definition
      Type: string
      Path: OperationDefinition.name

      See Also:
    • NAME

      public static final ca.uhn.fhir.rest.gclient.StringClientParam NAME
      Fluent Client search parameter constant for name

      Description: Computationally friendly name of the operation definition
      Type: string
      Path: OperationDefinition.name

    • SP_CONTEXT

      public static final String SP_CONTEXT
      Search parameter: context

      Description: A use context assigned to the operation definition
      Type: token
      Path: OperationDefinition.useContext.valueCodeableConcept

      See Also:
    • CONTEXT

      public static final ca.uhn.fhir.rest.gclient.TokenClientParam CONTEXT
      Fluent Client search parameter constant for context

      Description: A use context assigned to the operation definition
      Type: token
      Path: OperationDefinition.useContext.valueCodeableConcept

    • SP_PUBLISHER

      public static final String SP_PUBLISHER
      Search parameter: publisher

      Description: Name of the publisher of the operation definition
      Type: string
      Path: OperationDefinition.publisher

      See Also:
    • PUBLISHER

      public static final ca.uhn.fhir.rest.gclient.StringClientParam PUBLISHER
      Fluent Client search parameter constant for publisher

      Description: Name of the publisher of the operation definition
      Type: string
      Path: OperationDefinition.publisher

    • SP_CONTEXT_TYPE_QUANTITY

      public static final String SP_CONTEXT_TYPE_QUANTITY
      Search parameter: context-type-quantity

      Description: A use context type and quantity- or range-based value assigned to the operation definition
      Type: composite
      Path:

      See Also:
    • CONTEXT_TYPE_QUANTITY

      public static final ca.uhn.fhir.rest.gclient.CompositeClientParam<ca.uhn.fhir.rest.gclient.TokenClientParam,ca.uhn.fhir.rest.gclient.QuantityClientParam> CONTEXT_TYPE_QUANTITY
      Fluent Client search parameter constant for context-type-quantity

      Description: A use context type and quantity- or range-based value assigned to the operation definition
      Type: composite
      Path:

    • SP_STATUS

      public static final String SP_STATUS
      Search parameter: status

      Description: The current status of the operation definition
      Type: token
      Path: OperationDefinition.status

      See Also:
    • STATUS

      public static final ca.uhn.fhir.rest.gclient.TokenClientParam STATUS
      Fluent Client search parameter constant for status

      Description: The current status of the operation definition
      Type: token
      Path: OperationDefinition.status

    • SP_BASE

      public static final String SP_BASE
      Search parameter: base

      Description: Marks this as a profile of the base
      Type: reference
      Path: OperationDefinition.base

      See Also:
    • BASE

      public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam BASE
      Fluent Client search parameter constant for base

      Description: Marks this as a profile of the base
      Type: reference
      Path: OperationDefinition.base

    • INCLUDE_BASE

      public static final ca.uhn.fhir.model.api.Include INCLUDE_BASE
      Constant for fluent queries to be used to add include statements. Specifies the path value of "OperationDefinition:base".
  • Constructor Details

  • Method Details