Class OperationDefinition

java.lang.Object
ca.uhn.fhir.model.api.BaseElement
ca.uhn.fhir.model.dstu2.resource.BaseResource
ca.uhn.fhir.model.dstu2.resource.OperationDefinition
All Implemented Interfaces:
ca.uhn.fhir.model.api.ICompositeElement, ca.uhn.fhir.model.api.IElement, ca.uhn.fhir.model.api.IResource, ca.uhn.fhir.model.api.ISupportsUndeclaredExtensions, Serializable, org.hl7.fhir.instance.model.api.IBase, org.hl7.fhir.instance.model.api.IBaseResource

public class OperationDefinition extends BaseResource implements ca.uhn.fhir.model.api.IResource
HAPI/FHIR OperationDefinition Resource (conformance.behavior)

Definition: A formal computable definition of an operation (on the RESTful interface) or a named query (using the search interaction).

Requirements:

Profile Definition: http://hl7.org/fhir/profiles/OperationDefinition

See Also:
  • Field Details

    • SP_URL

      public static final String SP_URL
      Search parameter constant for url

      Description:
      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:
      Type: uri
      Path: OperationDefinition.url

    • SP_VERSION

      public static final String SP_VERSION
      Search parameter constant for version

      Description:
      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:
      Type: token
      Path: OperationDefinition.version

    • SP_NAME

      public static final String SP_NAME
      Search parameter constant for name

      Description:
      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:
      Type: string
      Path: OperationDefinition.name

    • SP_PUBLISHER

      public static final String SP_PUBLISHER
      Search parameter constant for publisher

      Description:
      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:
      Type: string
      Path: OperationDefinition.publisher

    • SP_CODE

      public static final String SP_CODE
      Search parameter constant for code

      Description:
      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:
      Type: token
      Path: OperationDefinition.code

    • SP_STATUS

      public static final String SP_STATUS
      Search parameter constant for status

      Description:
      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:
      Type: token
      Path: OperationDefinition.status

    • SP_DATE

      public static final String SP_DATE
      Search parameter constant for date

      Description:
      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:
      Type: date
      Path: OperationDefinition.date

    • SP_KIND

      public static final String SP_KIND
      Search parameter constant for kind

      Description:
      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:
      Type: token
      Path: OperationDefinition.kind

    • SP_BASE

      public static final String SP_BASE
      Search parameter constant for base

      Description:
      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:
      Type: reference
      Path: OperationDefinition.base

    • SP_SYSTEM

      public static final String SP_SYSTEM
      Search parameter constant for system

      Description:
      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:
      Type: token
      Path: OperationDefinition.system

    • SP_TYPE

      public static final String SP_TYPE
      Search parameter constant for type

      Description:
      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:
      Type: token
      Path: OperationDefinition.type

    • SP_INSTANCE

      public static final String SP_INSTANCE
      Search parameter constant for instance

      Description:
      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:
      Type: token
      Path: OperationDefinition.instance

    • SP_PROFILE

      public static final String SP_PROFILE
      Search parameter constant for profile

      Description:
      Type: reference
      Path: OperationDefinition.parameter.profile

      See Also:
    • PROFILE

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

      Description:
      Type: reference
      Path: OperationDefinition.parameter.profile

    • 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".
    • INCLUDE_PROFILE

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

  • Method Details

    • isEmpty

      public boolean isEmpty()
      Specified by:
      isEmpty in interface org.hl7.fhir.instance.model.api.IBase
    • getAllPopulatedChildElementsOfType

      public <T extends ca.uhn.fhir.model.api.IElement> List<T> getAllPopulatedChildElementsOfType(Class<T> theType)
      Specified by:
      getAllPopulatedChildElementsOfType in interface ca.uhn.fhir.model.api.ICompositeElement
    • getUrlElement

      public ca.uhn.fhir.model.primitive.UriDt getUrlElement()
      Gets the value(s) for url (id). creating it if it does not exist. Will not return null.

      Definition: 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

    • getUrl

      public String getUrl()
      Gets the value(s) for url (id). creating it if it does not exist. This method may return null.

      Definition: 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(ca.uhn.fhir.model.primitive.UriDt theValue)
      Sets the value(s) for url (id)

      Definition: 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

      Sets the value for url (id)

      Definition: 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 ca.uhn.fhir.model.primitive.StringDt getVersionElement()
      Gets the value(s) for version (id.version). creating it if it does not exist. Will not return null.

      Definition: 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

    • getVersion

      public String getVersion()
      Gets the value(s) for version (id.version). creating it if it does not exist. This method may return null.

      Definition: 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(ca.uhn.fhir.model.primitive.StringDt theValue)
      Sets the value(s) for version (id.version)

      Definition: 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

      Sets the value for version (id.version)

      Definition: 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 ca.uhn.fhir.model.primitive.StringDt getNameElement()
      Gets the value(s) for name (). creating it if it does not exist. Will not return null.

      Definition: A free text natural language name identifying the operation

    • getName

      public String getName()
      Gets the value(s) for name (). creating it if it does not exist. This method may return null.

      Definition: A free text natural language name identifying the operation

    • setName

      public OperationDefinition setName(ca.uhn.fhir.model.primitive.StringDt theValue)
      Sets the value(s) for name ()

      Definition: A free text natural language name identifying the operation

    • setName

      public OperationDefinition setName(String theString)
      Sets the value for name ()

      Definition: A free text natural language name identifying the operation

    • getStatusElement

      public ca.uhn.fhir.model.primitive.BoundCodeDt<ConformanceResourceStatusEnum> getStatusElement()
      Gets the value(s) for status (status). creating it if it does not exist. Will not return null.

      Definition: The status of the profile

    • getStatus

      public String getStatus()
      Gets the value(s) for status (status). creating it if it does not exist. This method may return null.

      Definition: The status of the profile

    • setStatus

      public OperationDefinition setStatus(ca.uhn.fhir.model.primitive.BoundCodeDt<ConformanceResourceStatusEnum> theValue)
      Sets the value(s) for status (status)

      Definition: The status of the profile

    • setStatus

      Sets the value(s) for status (status)

      Definition: The status of the profile

    • getKindElement

      public ca.uhn.fhir.model.primitive.BoundCodeDt<OperationKindEnum> getKindElement()
      Gets the value(s) for kind (class). creating it if it does not exist. Will not return null.

      Definition: Whether this is an operation or a named query

    • getKind

      public String getKind()
      Gets the value(s) for kind (class). creating it if it does not exist. This method may return null.

      Definition: Whether this is an operation or a named query

    • setKind

      public OperationDefinition setKind(ca.uhn.fhir.model.primitive.BoundCodeDt<OperationKindEnum> theValue)
      Sets the value(s) for kind (class)

      Definition: Whether this is an operation or a named query

    • setKind

      Sets the value(s) for kind (class)

      Definition: Whether this is an operation or a named query

    • getExperimentalElement

      public ca.uhn.fhir.model.primitive.BooleanDt getExperimentalElement()
      Gets the value(s) for experimental (). creating it if it does not exist. Will not return null.

      Definition: This profile was authored for testing purposes (or education/evaluation/marketing), and is not intended to be used for genuine usage

    • getExperimental

      Gets the value(s) for experimental (). creating it if it does not exist. This method may return null.

      Definition: 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(ca.uhn.fhir.model.primitive.BooleanDt theValue)
      Sets the value(s) for experimental ()

      Definition: 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 theBoolean)
      Sets the value for experimental ()

      Definition: This profile was authored for testing purposes (or education/evaluation/marketing), and is not intended to be used for genuine usage

    • getPublisherElement

      public ca.uhn.fhir.model.primitive.StringDt getPublisherElement()
      Gets the value(s) for publisher (who.witness). creating it if it does not exist. Will not return null.

      Definition: The name of the individual or organization that published the operation definition

    • getPublisher

      public String getPublisher()
      Gets the value(s) for publisher (who.witness). creating it if it does not exist. This method may return null.

      Definition: The name of the individual or organization that published the operation definition

    • setPublisher

      public OperationDefinition setPublisher(ca.uhn.fhir.model.primitive.StringDt theValue)
      Sets the value(s) for publisher (who.witness)

      Definition: The name of the individual or organization that published the operation definition

    • setPublisher

      Sets the value for publisher (who.witness)

      Definition: The name of the individual or organization that published the operation definition

    • getContact

      Gets the value(s) for contact (). creating it if it does not exist. Will not return null.

      Definition: Contacts to assist a user in finding and communicating with the publisher

    • setContact

      Sets the value(s) for contact ()

      Definition: Contacts to assist a user in finding and communicating with the publisher

    • addContact

      Adds and returns a new value for contact ()

      Definition: Contacts to assist a user in finding and communicating with the publisher

    • addContact

      Adds a given new value for contact ()

      Definition: Contacts to assist a user in finding and communicating with the publisher

      Parameters:
      theValue - The contact to add (must not be null)
    • getContactFirstRep

      Gets the first repetition for contact (), creating it if it does not already exist.

      Definition: Contacts to assist a user in finding and communicating with the publisher

    • getDateElement

      public ca.uhn.fhir.model.primitive.DateTimeDt getDateElement()
      Gets the value(s) for date (when.recorded). creating it if it does not exist. Will not return null.

      Definition: 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

    • getDate

      public Date getDate()
      Gets the value(s) for date (when.recorded). creating it if it does not exist. This method may return null.

      Definition: 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(ca.uhn.fhir.model.primitive.DateTimeDt theValue)
      Sets the value(s) for date (when.recorded)

      Definition: 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

    • setDateWithSecondsPrecision

      Sets the value for date (when.recorded)

      Definition: 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 theDate, ca.uhn.fhir.model.api.TemporalPrecisionEnum thePrecision)
      Sets the value for date (when.recorded)

      Definition: 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

    • getDescriptionElement

      public ca.uhn.fhir.model.primitive.StringDt getDescriptionElement()
      Gets the value(s) for description (). creating it if it does not exist. Will not return null.

      Definition: A free text natural language description of the profile and its use

    • getDescription

      Gets the value(s) for description (). creating it if it does not exist. This method may return null.

      Definition: A free text natural language description of the profile and its use

    • setDescription

      public OperationDefinition setDescription(ca.uhn.fhir.model.primitive.StringDt theValue)
      Sets the value(s) for description ()

      Definition: A free text natural language description of the profile and its use

    • setDescription

      Sets the value for description ()

      Definition: A free text natural language description of the profile and its use

    • getRequirementsElement

      public ca.uhn.fhir.model.primitive.StringDt getRequirementsElement()
      Gets the value(s) for requirements (). creating it if it does not exist. Will not return null.

      Definition: Explains why this operation definition is needed and why it's been constrained as it has

    • getRequirements

      Gets the value(s) for requirements (). creating it if it does not exist. This method may return null.

      Definition: Explains why this operation definition is needed and why it's been constrained as it has

    • setRequirements

      public OperationDefinition setRequirements(ca.uhn.fhir.model.primitive.StringDt theValue)
      Sets the value(s) for requirements ()

      Definition: Explains why this operation definition is needed and why it's been constrained as it has

    • setRequirements

      Sets the value for requirements ()

      Definition: Explains why this operation definition is needed and why it's been constrained as it has

    • getIdempotentElement

      public ca.uhn.fhir.model.primitive.BooleanDt getIdempotentElement()
      Gets the value(s) for idempotent (). creating it if it does not exist. Will not return null.

      Definition: 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

    • getIdempotent

      Gets the value(s) for idempotent (). creating it if it does not exist. This method may return null.

      Definition: 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(ca.uhn.fhir.model.primitive.BooleanDt theValue)
      Sets the value(s) for idempotent ()

      Definition: 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 theBoolean)
      Sets the value for idempotent ()

      Definition: 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 ca.uhn.fhir.model.primitive.CodeDt getCodeElement()
      Gets the value(s) for code (). creating it if it does not exist. Will not return null.

      Definition: The name used to invoke the operation

    • getCode

      public String getCode()
      Gets the value(s) for code (). creating it if it does not exist. This method may return null.

      Definition: The name used to invoke the operation

    • setCode

      public OperationDefinition setCode(ca.uhn.fhir.model.primitive.CodeDt theValue)
      Sets the value(s) for code ()

      Definition: The name used to invoke the operation

    • setCode

      Sets the value for code ()

      Definition: The name used to invoke the operation

    • getNotesElement

      public ca.uhn.fhir.model.primitive.StringDt getNotesElement()
      Gets the value(s) for notes (). creating it if it does not exist. Will not return null.

      Definition: Additional information about how to use this operation or named query

    • getNotes

      public String getNotes()
      Gets the value(s) for notes (). creating it if it does not exist. This method may return null.

      Definition: Additional information about how to use this operation or named query

    • setNotes

      public OperationDefinition setNotes(ca.uhn.fhir.model.primitive.StringDt theValue)
      Sets the value(s) for notes ()

      Definition: Additional information about how to use this operation or named query

    • setNotes

      public OperationDefinition setNotes(String theString)
      Sets the value for notes ()

      Definition: Additional information about how to use this operation or named query

    • getBase

      Gets the value(s) for base (). creating it if it does not exist. Will not return null.

      Definition: Indicates that this operation definition is a constraining profile on the base

    • setBase

      Sets the value(s) for base ()

      Definition: Indicates that this operation definition is a constraining profile on the base

    • getSystemElement

      public ca.uhn.fhir.model.primitive.BooleanDt getSystemElement()
      Gets the value(s) for system (). creating it if it does not exist. Will not return null.

      Definition: 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)

    • getSystem

      public Boolean getSystem()
      Gets the value(s) for system (). creating it if it does not exist. This method may return null.

      Definition: 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(ca.uhn.fhir.model.primitive.BooleanDt theValue)
      Sets the value(s) for system ()

      Definition: 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 theBoolean)
      Sets the value for system ()

      Definition: 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<ca.uhn.fhir.model.primitive.BoundCodeDt<ResourceTypeEnum>> getType()
      Gets the value(s) for type (). creating it if it does not exist. Will not return null.

      Definition: 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)

    • setType

      public OperationDefinition setType(List<ca.uhn.fhir.model.primitive.BoundCodeDt<ResourceTypeEnum>> theValue)
      Sets the value(s) for type ()

      Definition: 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 ca.uhn.fhir.model.primitive.BoundCodeDt<ResourceTypeEnum> addType(ResourceTypeEnum theValue)
      Add a value for type () using an enumerated type. This is intended as a convenience method for situations where the FHIR defined ValueSets are mandatory or contain the desirable codes. If you wish to use codes other than those which are built-in, you may also use the addType() method.

      Definition: 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)

    • getTypeFirstRep

      public ca.uhn.fhir.model.primitive.BoundCodeDt<ResourceTypeEnum> getTypeFirstRep()
      Gets the first repetition for type (), creating it if it does not already exist.

      Definition: 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 ca.uhn.fhir.model.primitive.BoundCodeDt<ResourceTypeEnum> addType()
      Add a value for type ()

      Definition: 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)

    • setType

      Sets the value(s), and clears any existing value(s) for type ()

      Definition: 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 ca.uhn.fhir.model.primitive.BooleanDt getInstanceElement()
      Gets the value(s) for instance (). creating it if it does not exist. Will not return null.

      Definition: Indicates whether this operation can be invoked on a particular instance of one of the given types

    • getInstance

      public Boolean getInstance()
      Gets the value(s) for instance (). creating it if it does not exist. This method may return null.

      Definition: Indicates whether this operation can be invoked on a particular instance of one of the given types

    • setInstance

      public OperationDefinition setInstance(ca.uhn.fhir.model.primitive.BooleanDt theValue)
      Sets the value(s) for instance ()

      Definition: Indicates whether this operation can be invoked on a particular instance of one of the given types

    • setInstance

      public OperationDefinition setInstance(boolean theBoolean)
      Sets the value for instance ()

      Definition: Indicates whether this operation can be invoked on a particular instance of one of the given types

    • getParameter

      Gets the value(s) for parameter (). creating it if it does not exist. Will not return null.

      Definition: The parameters for the operation/query

    • setParameter

      Sets the value(s) for parameter ()

      Definition: The parameters for the operation/query

    • addParameter

      Adds and returns a new value for parameter ()

      Definition: The parameters for the operation/query

    • addParameter

      Adds a given new value for parameter ()

      Definition: The parameters for the operation/query

      Parameters:
      theValue - The parameter to add (must not be null)
    • getParameterFirstRep

      Gets the first repetition for parameter (), creating it if it does not already exist.

      Definition: The parameters for the operation/query

    • getResourceName

      Specified by:
      getResourceName in interface ca.uhn.fhir.model.api.IResource
    • getStructureFhirVersionEnum

      public ca.uhn.fhir.context.FhirVersionEnum getStructureFhirVersionEnum()
      Specified by:
      getStructureFhirVersionEnum in interface org.hl7.fhir.instance.model.api.IBaseResource
      Specified by:
      getStructureFhirVersionEnum in interface ca.uhn.fhir.model.api.IResource