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

    public class OperationDefinition
    extends DomainResource
    A formal computable definition of an operation (on the RESTful interface) or a named query (using the search interaction).
    See Also:
    Serialized Form
    • Field Detail

      • url

        protected UriType url
        An absolute URL that is used to identify this operation definition when it is referenced in a specification, model, design or an instance. This SHALL be a URL, SHOULD be globally unique, and SHOULD be an address at which this operation definition is (or will be) published.
      • version

        protected StringType version
        The identifier that is used to identify this version of the profile when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the profile author manually and the value should be a timestamp.
      • name

        protected StringType name
        A free text natural language name identifying the operation.
      • experimental

        protected BooleanType experimental
        This profile was authored for testing purposes (or education/evaluation/marketing), and is not intended to be used for genuine usage.
      • date

        protected DateTimeType date
        The date this version of the operation definition was published. The date must change when the business version changes, if it does, and it must change if the status code changes. In addition, it should change when the substantive content of the Operation Definition changes.
      • publisher

        protected StringType publisher
        The name of the individual or organization that published the operation definition.
      • description

        protected StringType description
        A free text natural language description of the profile and its use.
      • useContext

        protected List<CodeableConcept> useContext
        The content was developed with a focus and intent of supporting the contexts that are listed. These terms may be used to assist with indexing and searching of operation definitions.
      • requirements

        protected StringType requirements
        Explains why this operation definition is needed and why it's been constrained as it has.
      • idempotent

        protected BooleanType idempotent
        Operations that are idempotent (see [HTTP specification definition of idempotent](http://www.w3.org/Protocols/rfc2616/rfc2616-sec9.html)) may be invoked by performing an HTTP GET operation instead of a POST.
      • code

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

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

        protected Reference base
        Indicates that this operation definition is a constraining profile on the base.
      • baseTarget

        protected OperationDefinition baseTarget
        The actual object that is the target of the reference (Indicates that this operation definition is a constraining profile on the base.)
      • 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 List<CodeType> 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 resource type for the context).
      • instance

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

        public static final String SP_STATUS
        Search parameter: status

        Description: draft | active | retired
        Type: token
        Path: OperationDefinition.status

        See Also:
        Constant Field Values
      • STATUS

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

        Description: draft | active | retired
        Type: token
        Path: OperationDefinition.status

      • SP_PARAMPROFILE

        public static final String SP_PARAMPROFILE
        Search parameter: paramprofile

        Description: Profile on the type
        Type: reference
        Path: OperationDefinition.parameter.profile

        See Also:
        Constant Field Values
      • PARAMPROFILE

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

        Description: Profile on the type
        Type: reference
        Path: OperationDefinition.parameter.profile

      • INCLUDE_PARAMPROFILE

        public static final ca.uhn.fhir.model.api.Include INCLUDE_PARAMPROFILE
        Constant for fluent queries to be used to add include statements. Specifies the path value of "OperationDefinition:paramprofile".
      • 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:
        Constant Field Values
      • 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_DATE

        public static final String SP_DATE
        Search parameter: date

        Description: Date for this version of the operation definition
        Type: date
        Path: OperationDefinition.date

        See Also:
        Constant Field Values
      • DATE

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

        Description: Date for this version of the operation definition
        Type: date
        Path: OperationDefinition.date

      • SP_TYPE

        public static final String SP_TYPE
        Search parameter: type

        Description: Invoke at resource level for these type
        Type: token
        Path: OperationDefinition.type

        See Also:
        Constant Field Values
      • TYPE

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

        Description: Invoke at resource level for these type
        Type: token
        Path: OperationDefinition.type

      • SP_URL

        public static final String SP_URL
        Search parameter: url

        Description: Logical URL to reference this operation definition
        Type: uri
        Path: OperationDefinition.url

        See Also:
        Constant Field Values
      • URL

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

        Description: Logical URL to reference this operation definition
        Type: uri
        Path: OperationDefinition.url

      • SP_KIND

        public static final String SP_KIND
        Search parameter: kind

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

        See Also:
        Constant Field Values
      • 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_VERSION

        public static final String SP_VERSION
        Search parameter: version

        Description: Logical id for this version of the operation definition
        Type: token
        Path: OperationDefinition.version

        See Also:
        Constant Field Values
      • VERSION

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

        Description: Logical id for this version of the operation definition
        Type: token
        Path: OperationDefinition.version

      • SP_PUBLISHER

        public static final String SP_PUBLISHER
        Search parameter: publisher

        Description: Name of the publisher (Organization or individual)
        Type: string
        Path: OperationDefinition.publisher

        See Also:
        Constant Field Values
      • PUBLISHER

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

        Description: Name of the publisher (Organization or individual)
        Type: string
        Path: OperationDefinition.publisher

      • SP_SYSTEM

        public static final String SP_SYSTEM
        Search parameter: system

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

        See Also:
        Constant Field Values
      • 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: Informal name for this operation
        Type: string
        Path: OperationDefinition.name

        See Also:
        Constant Field Values
      • NAME

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

        Description: Informal name for this operation
        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

        See Also:
        Constant Field Values
      • 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

      • 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:
        Constant Field Values
      • 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".
      • SP_INSTANCE

        public static final String SP_INSTANCE
        Search parameter: instance

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

        See Also:
        Constant Field Values
      • 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

    • Method Detail

      • getUrlElement

        public UriType getUrlElement()
        Returns:
        url (An absolute URL that is used to identify this operation definition when it is referenced in a specification, model, design or an instance. This SHALL be a URL, SHOULD be globally unique, and SHOULD be an address at which this operation definition is (or will be) published.). This is the underlying object with id, value and extensions. The accessor "getUrl" gives direct access to the value
      • hasUrl

        public boolean hasUrl()
      • setUrlElement

        public OperationDefinition setUrlElement​(UriType value)
        Parameters:
        value - url (An absolute URL that is used to identify this operation definition when it is referenced in a specification, model, design or an instance. This SHALL be a URL, SHOULD be globally unique, and SHOULD be an address at which this operation definition is (or will be) published.). This is the underlying object with id, value and extensions. The accessor "getUrl" gives direct access to the value
      • getUrl

        public String getUrl()
        Returns:
        An absolute URL that is used to identify this operation definition when it is referenced in a specification, model, design or an instance. This SHALL be a URL, SHOULD be globally unique, and SHOULD be an address at which this operation definition is (or will be) published.
      • setUrl

        public OperationDefinition setUrl​(String value)
        Parameters:
        value - An absolute URL that is used to identify this operation definition when it is referenced in a specification, model, design or an instance. This SHALL be a URL, SHOULD be globally unique, and SHOULD be an address at which this operation definition is (or will be) published.
      • getVersionElement

        public StringType getVersionElement()
        Returns:
        version (The identifier that is used to identify this version of the profile when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the profile author manually and the value should be a timestamp.). This is the underlying object with id, value and extensions. The accessor "getVersion" gives direct access to the value
      • setVersionElement

        public OperationDefinition setVersionElement​(StringType value)
        Parameters:
        value - version (The identifier that is used to identify this version of the profile when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the profile author manually and the value should be a timestamp.). This is the underlying object with id, value and extensions. The accessor "getVersion" gives direct access to the value
      • getVersion

        public String getVersion()
        Returns:
        The identifier that is used to identify this version of the profile when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the profile author manually and the value should be a timestamp.
      • setVersion

        public OperationDefinition setVersion​(String value)
        Parameters:
        value - The identifier that is used to identify this version of the profile when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the profile author manually and the value should be a timestamp.
      • getNameElement

        public StringType getNameElement()
        Returns:
        name (A free text natural language name identifying the operation.). This is the underlying object with id, value and extensions. The accessor "getName" gives direct access to the value
      • hasName

        public boolean hasName()
      • setNameElement

        public OperationDefinition setNameElement​(StringType value)
        Parameters:
        value - name (A free text natural language name identifying the operation.). This is the underlying object with id, value and extensions. The accessor "getName" gives direct access to the value
      • getName

        public String getName()
        Returns:
        A free text natural language name identifying the operation.
      • hasKind

        public boolean hasKind()
      • getExperimentalElement

        public BooleanType getExperimentalElement()
        Returns:
        experimental (This profile was authored for testing purposes (or education/evaluation/marketing), and is not intended to be used for genuine usage.). This is the underlying object with id, value and extensions. The accessor "getExperimental" gives direct access to the value
      • setExperimentalElement

        public OperationDefinition setExperimentalElement​(BooleanType value)
        Parameters:
        value - experimental (This profile was authored for testing purposes (or education/evaluation/marketing), and is not intended to be used for genuine usage.). This is the underlying object with id, value and extensions. The accessor "getExperimental" gives direct access to the value
      • getExperimental

        public boolean getExperimental()
        Returns:
        This profile was authored for testing purposes (or education/evaluation/marketing), and is not intended to be used for genuine usage.
      • setExperimental

        public OperationDefinition setExperimental​(boolean value)
        Parameters:
        value - This profile was authored for testing purposes (or education/evaluation/marketing), and is not intended to be used for genuine usage.
      • getDateElement

        public DateTimeType getDateElement()
        Returns:
        date (The date this version of the operation definition was published. The date must change when the business version changes, if it does, and it must change if the status code changes. In addition, it should change when the substantive content of the Operation Definition changes.). This is the underlying object with id, value and extensions. The accessor "getDate" gives direct access to the value
      • hasDate

        public boolean hasDate()
      • setDateElement

        public OperationDefinition setDateElement​(DateTimeType value)
        Parameters:
        value - date (The date this version of the operation definition was published. The date must change when the business version changes, if it does, and it must change if the status code changes. In addition, it should change when the substantive content of the Operation Definition changes.). This is the underlying object with id, value and extensions. The accessor "getDate" gives direct access to the value
      • getDate

        public Date getDate()
        Returns:
        The date this version of the operation definition was published. The date must change when the business version changes, if it does, and it must change if the status code changes. In addition, it should change when the substantive content of the Operation Definition changes.
      • setDate

        public OperationDefinition setDate​(Date value)
        Parameters:
        value - The date this version of the operation definition was published. The date must change when the business version changes, if it does, and it must change if the status code changes. In addition, it should change when the substantive content of the Operation Definition changes.
      • getPublisherElement

        public StringType getPublisherElement()
        Returns:
        publisher (The name of the individual or organization that published the operation definition.). This is the underlying object with id, value and extensions. The accessor "getPublisher" gives direct access to the value
      • setPublisherElement

        public OperationDefinition setPublisherElement​(StringType value)
        Parameters:
        value - publisher (The name of the individual or organization that published the operation definition.). This is the underlying object with id, value and extensions. The accessor "getPublisher" gives direct access to the value
      • getPublisher

        public String getPublisher()
        Returns:
        The name of the individual or organization that published the operation definition.
      • getDescriptionElement

        public StringType getDescriptionElement()
        Returns:
        description (A free text natural language description of the profile and its use.). This is the underlying object with id, value and extensions. The accessor "getDescription" gives direct access to the value
      • setDescriptionElement

        public OperationDefinition setDescriptionElement​(StringType value)
        Parameters:
        value - description (A free text natural language description of the profile and its use.). This is the underlying object with id, value and extensions. The accessor "getDescription" gives direct access to the value
      • getDescription

        public String getDescription()
        Returns:
        A free text natural language description of the profile and its use.
      • getUseContext

        public List<CodeableConceptgetUseContext()
        Returns:
        useContext (The content was developed with a focus and intent of supporting the contexts that are listed. These terms may be used to assist with indexing and searching of operation definitions.)
      • addUseContext

        public CodeableConcept addUseContext()
        Returns:
        useContext (The content was developed with a focus and intent of supporting the contexts that are listed. These terms may be used to assist with indexing and searching of operation definitions.)
      • getRequirementsElement

        public StringType getRequirementsElement()
        Returns:
        requirements (Explains why this operation definition is needed and why it's been constrained as it has.). This is the underlying object with id, value and extensions. The accessor "getRequirements" gives direct access to the value
      • setRequirementsElement

        public OperationDefinition setRequirementsElement​(StringType value)
        Parameters:
        value - requirements (Explains why this operation definition is needed and why it's been constrained as it has.). This is the underlying object with id, value and extensions. The accessor "getRequirements" gives direct access to the value
      • getRequirements

        public String getRequirements()
        Returns:
        Explains why this operation definition is needed and why it's been constrained as it has.
      • getIdempotentElement

        public BooleanType getIdempotentElement()
        Returns:
        idempotent (Operations that are idempotent (see [HTTP specification definition of idempotent](http://www.w3.org/Protocols/rfc2616/rfc2616-sec9.html)) may be invoked by performing an HTTP GET operation instead of a POST.). This is the underlying object with id, value and extensions. The accessor "getIdempotent" gives direct access to the value
      • setIdempotentElement

        public OperationDefinition setIdempotentElement​(BooleanType value)
        Parameters:
        value - idempotent (Operations that are idempotent (see [HTTP specification definition of idempotent](http://www.w3.org/Protocols/rfc2616/rfc2616-sec9.html)) may be invoked by performing an HTTP GET operation instead of a POST.). This is the underlying object with id, value and extensions. The accessor "getIdempotent" gives direct access to the value
      • getIdempotent

        public boolean getIdempotent()
        Returns:
        Operations that are idempotent (see [HTTP specification definition of idempotent](http://www.w3.org/Protocols/rfc2616/rfc2616-sec9.html)) may be invoked by performing an HTTP GET operation instead of a POST.
      • setIdempotent

        public OperationDefinition setIdempotent​(boolean value)
        Parameters:
        value - Operations that are idempotent (see [HTTP specification definition of idempotent](http://www.w3.org/Protocols/rfc2616/rfc2616-sec9.html)) may be invoked by performing an HTTP GET operation instead of a POST.
      • getCodeElement

        public CodeType getCodeElement()
        Returns:
        code (The name used to invoke the operation.). This is the underlying object with id, value and extensions. The accessor "getCode" gives direct access to the value
      • hasCode

        public boolean hasCode()
      • setCodeElement

        public OperationDefinition setCodeElement​(CodeType value)
        Parameters:
        value - code (The name used to invoke the operation.). This is the underlying object with id, value and extensions. The accessor "getCode" gives direct access to the value
      • getCode

        public String getCode()
        Returns:
        The name used to invoke the operation.
      • getCommentElement

        public StringType getCommentElement()
        Returns:
        comment (Additional information about how to use this operation or named query.). This is the underlying object with id, value and extensions. The accessor "getComment" gives direct access to the value
      • setCommentElement

        public OperationDefinition setCommentElement​(StringType value)
        Parameters:
        value - comment (Additional information about how to use this operation or named query.). This is the underlying object with id, value and extensions. The accessor "getComment" gives direct access to the value
      • getComment

        public String getComment()
        Returns:
        Additional information about how to use this operation or named query.
      • getBase

        public Reference getBase()
        Returns:
        base (Indicates that this operation definition is a constraining profile on the base.)
      • hasBase

        public boolean hasBase()
      • getBaseTarget

        public OperationDefinition getBaseTarget()
        Returns:
        base The actual object that is the target of the reference. The reference library doesn't populate this, but you can use it to hold the resource if you resolve it. (Indicates that this operation definition is a constraining profile on the base.)
      • setBaseTarget

        public OperationDefinition setBaseTarget​(OperationDefinition value)
        Parameters:
        value - base The actual object that is the target of the reference. The reference library doesn't use these, but you can use it to hold the resource if you resolve it. (Indicates that this operation definition is a constraining profile on the base.)
      • getSystemElement

        public BooleanType getSystemElement()
        Returns:
        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).). This is the underlying object with id, value and extensions. The accessor "getSystem" gives direct access to the value
      • setSystemElement

        public OperationDefinition setSystemElement​(BooleanType value)
        Parameters:
        value - 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).). This is the underlying object with id, value and extensions. The accessor "getSystem" gives direct access to the value
      • getSystem

        public boolean getSystem()
        Returns:
        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).
      • setSystem

        public OperationDefinition setSystem​(boolean value)
        Parameters:
        value - 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).
      • getType

        public List<CodeTypegetType()
        Returns:
        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 resource type for the context).)
      • hasType

        public boolean hasType()
      • addTypeElement

        public CodeType addTypeElement()
        Returns:
        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 resource type for the context).)
      • addType

        public OperationDefinition addType​(String value)
        Parameters:
        value - 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 resource type for the context).)
      • hasType

        public boolean hasType​(String value)
        Parameters:
        value - 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 resource type for the context).)
      • getInstanceElement

        public BooleanType getInstanceElement()
        Returns:
        instance (Indicates whether this operation can be invoked on a particular instance of one of the given types.). This is the underlying object with id, value and extensions. The accessor "getInstance" gives direct access to the value
      • setInstanceElement

        public OperationDefinition setInstanceElement​(BooleanType value)
        Parameters:
        value - instance (Indicates whether this operation can be invoked on a particular instance of one of the given types.). This is the underlying object with id, value and extensions. The accessor "getInstance" gives direct access to the value
      • getInstance

        public boolean getInstance()
        Returns:
        Indicates whether this operation can be invoked on a particular instance of one of the given types.
      • setInstance

        public OperationDefinition setInstance​(boolean value)
        Parameters:
        value - Indicates whether this operation can be invoked on a particular instance of one of the given types.
      • getProperty

        public Base[] getProperty​(int hash,
                                  String name,
                                  boolean checkValid)
                           throws org.hl7.fhir.exceptions.FHIRException
        Overrides:
        getProperty in class DomainResource
        Throws:
        org.hl7.fhir.exceptions.FHIRException
      • makeProperty

        public Base makeProperty​(int hash,
                                 String name)
                          throws org.hl7.fhir.exceptions.FHIRException
        Description copied from class: Base
        make an instance of a property. If the property is a repeating property, make a new instance. if the property is not repeating, return the property
        Overrides:
        makeProperty in class DomainResource
        Returns:
        Throws:
        org.hl7.fhir.exceptions.FHIRException
      • isEmpty

        public boolean isEmpty()
        Specified by:
        isEmpty in interface org.hl7.fhir.instance.model.api.IBase
        Overrides:
        isEmpty in class DomainResource