Class OperationDefinition
- java.lang.Object
-
- org.hl7.fhir.dstu3.model.Base
-
- org.hl7.fhir.dstu3.model.BaseResource
-
- org.hl7.fhir.dstu3.model.Resource
-
- org.hl7.fhir.dstu3.model.DomainResource
-
- org.hl7.fhir.dstu3.model.MetadataResource
-
- org.hl7.fhir.dstu3.model.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 MetadataResource
A formal computable definition of an operation (on the RESTful interface) or a named query (using the search interaction).- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classOperationDefinition.OperationDefinitionOverloadComponentstatic classOperationDefinition.OperationDefinitionParameterBindingComponentstatic classOperationDefinition.OperationDefinitionParameterComponentstatic classOperationDefinition.OperationKindstatic classOperationDefinition.OperationKindEnumFactorystatic classOperationDefinition.OperationParameterUsestatic classOperationDefinition.OperationParameterUseEnumFactory
-
Field Summary
Fields Modifier and Type Field Description protected ReferencebaseIndicates that this operation definition is a constraining profile on the base.static ca.uhn.fhir.rest.gclient.ReferenceClientParamBASEFluent Client search parameter constant for baseprotected OperationDefinitionbaseTargetThe actual object that is the target of the reference (Indicates that this operation definition is a constraining profile on the base.)protected CodeTypecodeThe name used to invoke the operation.static ca.uhn.fhir.rest.gclient.TokenClientParamCODEFluent Client search parameter constant for codeprotected StringTypecommentAdditional information about how to use this operation or named query.static ca.uhn.fhir.rest.gclient.DateClientParamDATEFluent Client search parameter constant for datestatic ca.uhn.fhir.rest.gclient.StringClientParamDESCRIPTIONFluent Client search parameter constant for descriptionprotected BooleanTypeidempotentOperations 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.static ca.uhn.fhir.model.api.IncludeINCLUDE_BASEConstant for fluent queries to be used to add include statements.static ca.uhn.fhir.model.api.IncludeINCLUDE_PARAM_PROFILEConstant for fluent queries to be used to add include statements.protected BooleanTypeinstanceIndicates whether this operation can be invoked on a particular instance of one of the given types.static ca.uhn.fhir.rest.gclient.TokenClientParamINSTANCEFluent Client search parameter constant for instancestatic ca.uhn.fhir.rest.gclient.TokenClientParamJURISDICTIONFluent Client search parameter constant for jurisdictionprotected Enumeration<OperationDefinition.OperationKind>kindWhether this is an operation or a named query.static ca.uhn.fhir.rest.gclient.TokenClientParamKINDFluent Client search parameter constant for kindstatic ca.uhn.fhir.rest.gclient.StringClientParamNAMEFluent Client search parameter constant for nameprotected List<OperationDefinition.OperationDefinitionOverloadComponent>overloadDefines an appropriate combination of parameters to use when invoking this operation, to help code generators when generating overloaded parameter sets for this operation.static ca.uhn.fhir.rest.gclient.ReferenceClientParamPARAM_PROFILEFluent Client search parameter constant for param-profileprotected List<OperationDefinition.OperationDefinitionParameterComponent>parameterThe parameters for the operation/query.static ca.uhn.fhir.rest.gclient.StringClientParamPUBLISHERFluent Client search parameter constant for publisherprotected MarkdownTypepurposeExplaination of why this operation definition is needed and why it has been designed as it has.protected List<CodeType>resourceThe types on which this operation can be executed.static StringSP_BASESearch parameter: basestatic StringSP_CODESearch parameter: codestatic StringSP_DATESearch parameter: datestatic StringSP_DESCRIPTIONSearch parameter: descriptionstatic StringSP_INSTANCESearch parameter: instancestatic StringSP_JURISDICTIONSearch parameter: jurisdictionstatic StringSP_KINDSearch parameter: kindstatic StringSP_NAMESearch parameter: namestatic StringSP_PARAM_PROFILESearch parameter: param-profilestatic StringSP_PUBLISHERSearch parameter: publisherstatic StringSP_STATUSSearch parameter: statusstatic StringSP_SYSTEMSearch parameter: systemstatic StringSP_TYPESearch parameter: typestatic StringSP_URLSearch parameter: urlstatic StringSP_VERSIONSearch parameter: versionstatic ca.uhn.fhir.rest.gclient.TokenClientParamSTATUSFluent Client search parameter constant for statusprotected BooleanTypesystemIndicates whether this operation or named query can be invoked at the system level (e.g.static ca.uhn.fhir.rest.gclient.TokenClientParamSYSTEMFluent Client search parameter constant for systemprotected BooleanTypetypeIndicates whether this operation or named query can be invoked at the resource type level for any given resource type level (e.g.static ca.uhn.fhir.rest.gclient.TokenClientParamTYPEFluent Client search parameter constant for typestatic ca.uhn.fhir.rest.gclient.UriClientParamURLFluent Client search parameter constant for urlstatic ca.uhn.fhir.rest.gclient.TokenClientParamVERSIONFluent Client search parameter constant for version-
Fields inherited from class org.hl7.fhir.dstu3.model.MetadataResource
contact, date, description, experimental, jurisdiction, name, publisher, status, title, url, useContext, version
-
Fields inherited from class org.hl7.fhir.dstu3.model.DomainResource
contained, extension, modifierExtension, text
-
Fields inherited from class org.hl7.fhir.dstu3.model.Resource
id, implicitRules, language, meta
-
-
Constructor Summary
Constructors Constructor Description OperationDefinition()ConstructorOperationDefinition(StringType name, Enumeration<Enumerations.PublicationStatus> status, Enumeration<OperationDefinition.OperationKind> kind, CodeType code, BooleanType system, BooleanType type, BooleanType instance)Constructor
-
Method Summary
-
Methods inherited from class org.hl7.fhir.dstu3.model.MetadataResource
checkCanUseUrl, copyValues, getTitle, getTitleElement, hasTitle, hasTitleElement, setTitle, setTitleElement, toString
-
Methods inherited from class org.hl7.fhir.dstu3.model.DomainResource
addContained, addExtension, addExtension, addExtension, addModifierExtension, addModifierExtension, copyValues, getContained, getExtension, getExtensionByUrl, getExtensionsByUrl, getModifierExtension, getModifierExtensionsByUrl, getText, hasContained, hasExtension, hasExtension, hasModifierExtension, hasText, setContained, setExtension, setModifierExtension, setText
-
Methods inherited from class org.hl7.fhir.dstu3.model.Resource
copyValues, getId, getIdBase, getIdElement, getIdPart, getImplicitRules, getImplicitRulesElement, getLanguage, getLanguageElement, getMeta, hasId, hasIdElement, hasImplicitRules, hasImplicitRulesElement, hasLanguage, hasLanguageElement, hasMeta, setId, setIdBase, setIdElement, setImplicitRules, setImplicitRulesElement, setLanguage, setLanguageElement, setMeta
-
Methods inherited from class org.hl7.fhir.dstu3.model.BaseResource
getStructureFhirVersionEnum, isResource, setId
-
Methods inherited from class org.hl7.fhir.dstu3.model.Base
castToAddress, castToAnnotation, castToAttachment, castToBase64Binary, castToBoolean, castToCode, castToCodeableConcept, castToCoding, castToContactDetail, castToContactPoint, castToContributor, castToDataRequirement, castToDate, castToDateTime, castToDecimal, castToDosage, castToDuration, castToElementDefinition, castToExtension, castToHumanName, castToId, castToIdentifier, castToInstant, castToInteger, castToMarkdown, castToMeta, castToMoney, castToNarrative, castToOid, castToParameterDefinition, castToPeriod, castToPositiveInt, castToQuantity, castToRange, castToRatio, castToReference, castToRelatedArtifact, castToResource, castToSampledData, castToSignature, castToSimpleQuantity, castToString, castToTime, castToTiming, castToTriggerDefinition, castToType, castToUnsignedInt, castToUri, castToUsageContext, castToXhtml, castToXhtmlString, children, clearUserData, compareDeep, compareDeep, compareDeep, compareValues, compareValues, equals, getChildByName, getFormatCommentsPost, getFormatCommentsPre, getNamedProperty, getUserData, getUserInt, getUserString, hasFormatComment, hasPrimitiveValue, hasType, hasUserData, isBooleanPrimitive, isMetadataBased, isPrimitive, listChildrenByName, listChildrenByName, primitiveValue, setUserData, setUserDataINN
-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface org.hl7.fhir.instance.model.api.IAnyResource
getId, getIdElement, getLanguageElement, getUserData, setId, setUserData
-
-
-
-
Field Detail
-
kind
protected Enumeration<OperationDefinition.OperationKind> kind
Whether this is an operation or a named query.
-
purpose
protected MarkdownType purpose
Explaination of why this operation definition is needed and why it has been designed 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.
-
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 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.
-
parameter
protected List<OperationDefinition.OperationDefinitionParameterComponent> parameter
The parameters for the operation/query.
-
overload
protected List<OperationDefinition.OperationDefinitionOverloadComponent> 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: dateDescription: The operation definition publication date
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 dateDescription: The operation definition publication date
Type: date
Path: OperationDefinition.date
-
SP_CODE
public static final String SP_CODE
Search parameter: codeDescription: 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 codeDescription: Name used to invoke the operation
Type: token
Path: OperationDefinition.code
-
SP_INSTANCE
public static final String SP_INSTANCE
Search parameter: instanceDescription: 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 instanceDescription: Invoke on an instance?
Type: token
Path: OperationDefinition.instance
-
SP_KIND
public static final String SP_KIND
Search parameter: kindDescription: 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 kindDescription: operation | query
Type: token
Path: OperationDefinition.kind
-
SP_JURISDICTION
public static final String SP_JURISDICTION
Search parameter: jurisdictionDescription: Intended jurisdiction for the operation definition
Type: token
Path: OperationDefinition.jurisdiction
- See Also:
- Constant Field Values
-
JURISDICTION
public static final ca.uhn.fhir.rest.gclient.TokenClientParam JURISDICTION
Fluent Client search parameter constant for jurisdictionDescription: Intended jurisdiction for the operation definition
Type: token
Path: OperationDefinition.jurisdiction
-
SP_DESCRIPTION
public static final String SP_DESCRIPTION
Search parameter: descriptionDescription: The description of the operation definition
Type: string
Path: OperationDefinition.description
- See Also:
- Constant Field Values
-
DESCRIPTION
public static final ca.uhn.fhir.rest.gclient.StringClientParam DESCRIPTION
Fluent Client search parameter constant for descriptionDescription: The description of the operation definition
Type: string
Path: OperationDefinition.description
-
SP_TYPE
public static final String SP_TYPE
Search parameter: typeDescription: Invole at the type level?
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 typeDescription: Invole at the type level?
Type: token
Path: OperationDefinition.type
-
SP_VERSION
public static final String SP_VERSION
Search parameter: versionDescription: The business 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 versionDescription: The business version of the operation definition
Type: token
Path: OperationDefinition.version
-
SP_URL
public static final String SP_URL
Search parameter: urlDescription: The uri that identifies the 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 urlDescription: The uri that identifies the operation definition
Type: uri
Path: OperationDefinition.url
-
SP_SYSTEM
public static final String SP_SYSTEM
Search parameter: systemDescription: 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 systemDescription: Invoke at the system level?
Type: token
Path: OperationDefinition.system
-
SP_NAME
public static final String SP_NAME
Search parameter: nameDescription: Computationally friendly name of the operation definition
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 nameDescription: Computationally friendly name of the operation definition
Type: string
Path: OperationDefinition.name
-
SP_PUBLISHER
public static final String SP_PUBLISHER
Search parameter: publisherDescription: Name of the publisher of the operation definition
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 publisherDescription: Name of the publisher of the operation definition
Type: string
Path: OperationDefinition.publisher
-
SP_PARAM_PROFILE
public static final String SP_PARAM_PROFILE
Search parameter: param-profileDescription: Profile on the type
Type: reference
Path: OperationDefinition.parameter.profile
- See Also:
- Constant Field Values
-
PARAM_PROFILE
public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam PARAM_PROFILE
Fluent Client search parameter constant for param-profileDescription: Profile on the type
Type: reference
Path: OperationDefinition.parameter.profile
-
INCLUDE_PARAM_PROFILE
public static final ca.uhn.fhir.model.api.Include INCLUDE_PARAM_PROFILE
Constant for fluent queries to be used to add include statements. Specifies the path value of "OperationDefinition:param-profile".
-
SP_STATUS
public static final String SP_STATUS
Search parameter: statusDescription: The current status of the operation definition
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 statusDescription: The current status of the operation definition
Type: token
Path: OperationDefinition.status
-
SP_BASE
public static final String SP_BASE
Search parameter: baseDescription: 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 baseDescription: 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 Detail
-
OperationDefinition
public OperationDefinition()
Constructor
-
OperationDefinition
public OperationDefinition(StringType name, Enumeration<Enumerations.PublicationStatus> status, Enumeration<OperationDefinition.OperationKind> kind, CodeType code, BooleanType system, BooleanType type, BooleanType instance)
Constructor
-
-
Method Detail
-
getUrlElement
public UriType getUrlElement()
- Overrides:
getUrlElementin classMetadataResource- Returns:
MetadataResource.url(An absolute URI 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. The URL SHOULD include the major version of the operation definition. For more information see [Technical and Business Versions](resource.html#versions).). This is the underlying object with id, value and extensions. The accessor "getUrl" gives direct access to the value
-
hasUrlElement
public boolean hasUrlElement()
- Overrides:
hasUrlElementin classMetadataResource
-
hasUrl
public boolean hasUrl()
- Overrides:
hasUrlin classMetadataResource
-
setUrlElement
public OperationDefinition setUrlElement(UriType value)
- Overrides:
setUrlElementin classMetadataResource- Parameters:
value-MetadataResource.url(An absolute URI 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. The URL SHOULD include the major version of the operation definition. For more information see [Technical and Business Versions](resource.html#versions).). This is the underlying object with id, value and extensions. The accessor "getUrl" gives direct access to the value
-
getUrl
public String getUrl()
- Overrides:
getUrlin classMetadataResource- Returns:
- An absolute URI 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. The URL SHOULD include the major version of the operation definition. For more information see [Technical and Business Versions](resource.html#versions).
-
setUrl
public OperationDefinition setUrl(String value)
- Overrides:
setUrlin classMetadataResource- Parameters:
value- An absolute URI 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. The URL SHOULD include the major version of the operation definition. For more information see [Technical and Business Versions](resource.html#versions).
-
getVersionElement
public StringType getVersionElement()
- Overrides:
getVersionElementin classMetadataResource- Returns:
MetadataResource.version(The identifier that is used to identify this version of the operation definition when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the operation definition author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence.). This is the underlying object with id, value and extensions. The accessor "getVersion" gives direct access to the value
-
hasVersionElement
public boolean hasVersionElement()
- Overrides:
hasVersionElementin classMetadataResource
-
hasVersion
public boolean hasVersion()
- Overrides:
hasVersionin classMetadataResource
-
setVersionElement
public OperationDefinition setVersionElement(StringType value)
- Overrides:
setVersionElementin classMetadataResource- Parameters:
value-MetadataResource.version(The identifier that is used to identify this version of the operation definition when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the operation definition author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence.). This is the underlying object with id, value and extensions. The accessor "getVersion" gives direct access to the value
-
getVersion
public String getVersion()
- Overrides:
getVersionin classMetadataResource- Returns:
- The identifier that is used to identify this version of the operation definition when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the operation definition author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence.
-
setVersion
public OperationDefinition setVersion(String value)
- Overrides:
setVersionin classMetadataResource- Parameters:
value- The identifier that is used to identify this version of the operation definition when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the operation definition author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence.
-
getNameElement
public StringType getNameElement()
- Overrides:
getNameElementin classMetadataResource- Returns:
MetadataResource.name(A natural language name identifying the operation definition. This name should be usable as an identifier for the module by machine processing applications such as code generation.). This is the underlying object with id, value and extensions. The accessor "getName" gives direct access to the value
-
hasNameElement
public boolean hasNameElement()
- Overrides:
hasNameElementin classMetadataResource
-
hasName
public boolean hasName()
- Overrides:
hasNamein classMetadataResource
-
setNameElement
public OperationDefinition setNameElement(StringType value)
- Overrides:
setNameElementin classMetadataResource- Parameters:
value-MetadataResource.name(A natural language name identifying the operation definition. This name should be usable as an identifier for the module by machine processing applications such as code generation.). This is the underlying object with id, value and extensions. The accessor "getName" gives direct access to the value
-
getName
public String getName()
- Overrides:
getNamein classMetadataResource- Returns:
- A natural language name identifying the operation definition. This name should be usable as an identifier for the module by machine processing applications such as code generation.
-
setName
public OperationDefinition setName(String value)
- Overrides:
setNamein classMetadataResource- Parameters:
value- A natural language name identifying the operation definition. This name should be usable as an identifier for the module by machine processing applications such as code generation.
-
getStatusElement
public Enumeration<Enumerations.PublicationStatus> getStatusElement()
- Overrides:
getStatusElementin classMetadataResource- Returns:
MetadataResource.status(The status of this operation definition. Enables tracking the life-cycle of the content.). This is the underlying object with id, value and extensions. The accessor "getStatus" gives direct access to the value
-
hasStatusElement
public boolean hasStatusElement()
- Overrides:
hasStatusElementin classMetadataResource
-
hasStatus
public boolean hasStatus()
- Overrides:
hasStatusin classMetadataResource
-
setStatusElement
public OperationDefinition setStatusElement(Enumeration<Enumerations.PublicationStatus> value)
- Overrides:
setStatusElementin classMetadataResource- Parameters:
value-MetadataResource.status(The status of this operation definition. Enables tracking the life-cycle of the content.). This is the underlying object with id, value and extensions. The accessor "getStatus" gives direct access to the value
-
getStatus
public Enumerations.PublicationStatus getStatus()
- Overrides:
getStatusin classMetadataResource- Returns:
- The status of this operation definition. Enables tracking the life-cycle of the content.
-
setStatus
public OperationDefinition setStatus(Enumerations.PublicationStatus value)
- Overrides:
setStatusin classMetadataResource- Parameters:
value- The status of this operation definition. Enables tracking the life-cycle of the content.
-
getKindElement
public Enumeration<OperationDefinition.OperationKind> getKindElement()
- Returns:
kind(Whether this is an operation or a named query.). This is the underlying object with id, value and extensions. The accessor "getKind" gives direct access to the value
-
hasKindElement
public boolean hasKindElement()
-
hasKind
public boolean hasKind()
-
setKindElement
public OperationDefinition setKindElement(Enumeration<OperationDefinition.OperationKind> value)
- Parameters:
value-kind(Whether this is an operation or a named query.). This is the underlying object with id, value and extensions. The accessor "getKind" gives direct access to the value
-
getKind
public OperationDefinition.OperationKind getKind()
- Returns:
- Whether this is an operation or a named query.
-
setKind
public OperationDefinition setKind(OperationDefinition.OperationKind value)
- Parameters:
value- Whether this is an operation or a named query.
-
getExperimentalElement
public BooleanType getExperimentalElement()
- Overrides:
getExperimentalElementin classMetadataResource- Returns:
MetadataResource.experimental(A boolean value to indicate that this operation definition is 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
-
hasExperimentalElement
public boolean hasExperimentalElement()
- Overrides:
hasExperimentalElementin classMetadataResource
-
hasExperimental
public boolean hasExperimental()
- Overrides:
hasExperimentalin classMetadataResource
-
setExperimentalElement
public OperationDefinition setExperimentalElement(BooleanType value)
- Overrides:
setExperimentalElementin classMetadataResource- Parameters:
value-MetadataResource.experimental(A boolean value to indicate that this operation definition is 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()
- Overrides:
getExperimentalin classMetadataResource- Returns:
- A boolean value to indicate that this operation definition is authored for testing purposes (or education/evaluation/marketing), and is not intended to be used for genuine usage.
-
setExperimental
public OperationDefinition setExperimental(boolean value)
- Overrides:
setExperimentalin classMetadataResource- Parameters:
value- A boolean value to indicate that this operation definition is authored for testing purposes (or education/evaluation/marketing), and is not intended to be used for genuine usage.
-
getDateElement
public DateTimeType getDateElement()
- Overrides:
getDateElementin classMetadataResource- Returns:
MetadataResource.date(The date (and optionally time) when the operation definition was published. The date must change if and when the business version changes 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
-
hasDateElement
public boolean hasDateElement()
- Overrides:
hasDateElementin classMetadataResource
-
hasDate
public boolean hasDate()
- Overrides:
hasDatein classMetadataResource
-
setDateElement
public OperationDefinition setDateElement(DateTimeType value)
- Overrides:
setDateElementin classMetadataResource- Parameters:
value-MetadataResource.date(The date (and optionally time) when the operation definition was published. The date must change if and when the business version changes 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()
- Overrides:
getDatein classMetadataResource- Returns:
- The date (and optionally time) when the operation definition was published. The date must change if and when the business version changes 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)
- Overrides:
setDatein classMetadataResource- Parameters:
value- The date (and optionally time) when the operation definition was published. The date must change if and when the business version changes 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()
- Overrides:
getPublisherElementin classMetadataResource- Returns:
MetadataResource.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
-
hasPublisherElement
public boolean hasPublisherElement()
- Overrides:
hasPublisherElementin classMetadataResource
-
hasPublisher
public boolean hasPublisher()
- Overrides:
hasPublisherin classMetadataResource
-
setPublisherElement
public OperationDefinition setPublisherElement(StringType value)
- Overrides:
setPublisherElementin classMetadataResource- Parameters:
value-MetadataResource.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()
- Overrides:
getPublisherin classMetadataResource- Returns:
- The name of the individual or organization that published the operation definition.
-
setPublisher
public OperationDefinition setPublisher(String value)
- Overrides:
setPublisherin classMetadataResource- Parameters:
value- The name of the individual or organization that published the operation definition.
-
getContact
public List<ContactDetail> getContact()
- Overrides:
getContactin classMetadataResource- Returns:
MetadataResource.contact(Contact details to assist a user in finding and communicating with the publisher.)
-
setContact
public OperationDefinition setContact(List<ContactDetail> theContact)
- Overrides:
setContactin classMetadataResource- Returns:
- Returns a reference to
thisfor easy method chaining
-
hasContact
public boolean hasContact()
- Overrides:
hasContactin classMetadataResource
-
addContact
public ContactDetail addContact()
- Overrides:
addContactin classMetadataResource
-
addContact
public OperationDefinition addContact(ContactDetail t)
- Overrides:
addContactin classMetadataResource
-
getContactFirstRep
public ContactDetail getContactFirstRep()
- Overrides:
getContactFirstRepin classMetadataResource- Returns:
- The first repetition of repeating field
MetadataResource.contact, creating it if it does not already exist
-
getDescriptionElement
public MarkdownType getDescriptionElement()
- Overrides:
getDescriptionElementin classMetadataResource- Returns:
MetadataResource.description(A free text natural language description of the operation definition from a consumer's perspective.). This is the underlying object with id, value and extensions. The accessor "getDescription" gives direct access to the value
-
hasDescriptionElement
public boolean hasDescriptionElement()
- Overrides:
hasDescriptionElementin classMetadataResource
-
hasDescription
public boolean hasDescription()
- Overrides:
hasDescriptionin classMetadataResource
-
setDescriptionElement
public OperationDefinition setDescriptionElement(MarkdownType value)
- Overrides:
setDescriptionElementin classMetadataResource- Parameters:
value-MetadataResource.description(A free text natural language description of the operation definition from a consumer's perspective.). This is the underlying object with id, value and extensions. The accessor "getDescription" gives direct access to the value
-
getDescription
public String getDescription()
- Overrides:
getDescriptionin classMetadataResource- Returns:
- A free text natural language description of the operation definition from a consumer's perspective.
-
setDescription
public OperationDefinition setDescription(String value)
- Overrides:
setDescriptionin classMetadataResource- Parameters:
value- A free text natural language description of the operation definition from a consumer's perspective.
-
getUseContext
public List<UsageContext> getUseContext()
- Overrides:
getUseContextin classMetadataResource- Returns:
MetadataResource.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 for appropriate operation definition instances.)
-
setUseContext
public OperationDefinition setUseContext(List<UsageContext> theUseContext)
- Overrides:
setUseContextin classMetadataResource- Returns:
- Returns a reference to
thisfor easy method chaining
-
hasUseContext
public boolean hasUseContext()
- Overrides:
hasUseContextin classMetadataResource
-
addUseContext
public UsageContext addUseContext()
- Overrides:
addUseContextin classMetadataResource
-
addUseContext
public OperationDefinition addUseContext(UsageContext t)
- Overrides:
addUseContextin classMetadataResource
-
getUseContextFirstRep
public UsageContext getUseContextFirstRep()
- Overrides:
getUseContextFirstRepin classMetadataResource- Returns:
- The first repetition of repeating field
MetadataResource.useContext, creating it if it does not already exist
-
getJurisdiction
public List<CodeableConcept> getJurisdiction()
- Overrides:
getJurisdictionin classMetadataResource- Returns:
MetadataResource.jurisdiction(A legal or geographic region in which the operation definition is intended to be used.)
-
setJurisdiction
public OperationDefinition setJurisdiction(List<CodeableConcept> theJurisdiction)
- Overrides:
setJurisdictionin classMetadataResource- Returns:
- Returns a reference to
thisfor easy method chaining
-
hasJurisdiction
public boolean hasJurisdiction()
- Overrides:
hasJurisdictionin classMetadataResource
-
addJurisdiction
public CodeableConcept addJurisdiction()
- Overrides:
addJurisdictionin classMetadataResource
-
addJurisdiction
public OperationDefinition addJurisdiction(CodeableConcept t)
- Overrides:
addJurisdictionin classMetadataResource
-
getJurisdictionFirstRep
public CodeableConcept getJurisdictionFirstRep()
- Overrides:
getJurisdictionFirstRepin classMetadataResource- Returns:
- The first repetition of repeating field
MetadataResource.jurisdiction, creating it if it does not already exist
-
getPurposeElement
public MarkdownType getPurposeElement()
- Returns:
purpose(Explaination of why this operation definition is needed and why it has been designed as it has.). This is the underlying object with id, value and extensions. The accessor "getPurpose" gives direct access to the value
-
hasPurposeElement
public boolean hasPurposeElement()
-
hasPurpose
public boolean hasPurpose()
-
setPurposeElement
public OperationDefinition setPurposeElement(MarkdownType value)
- Parameters:
value-purpose(Explaination of why this operation definition is needed and why it has been designed as it has.). This is the underlying object with id, value and extensions. The accessor "getPurpose" gives direct access to the value
-
getPurpose
public String getPurpose()
- Returns:
- Explaination of why this operation definition is needed and why it has been designed as it has.
-
setPurpose
public OperationDefinition setPurpose(String value)
- Parameters:
value- Explaination of why this operation definition is needed and why it has been designed 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
-
hasIdempotentElement
public boolean hasIdempotentElement()
-
hasIdempotent
public boolean hasIdempotent()
-
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
-
hasCodeElement
public boolean hasCodeElement()
-
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
-
setCode
public OperationDefinition setCode(String value)
- Parameters:
value- 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
-
hasCommentElement
public boolean hasCommentElement()
-
hasComment
public boolean hasComment()
-
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.
-
setComment
public OperationDefinition setComment(String value)
- Parameters:
value- 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()
-
setBase
public OperationDefinition setBase(Reference value)
- Parameters:
value-base(Indicates that this operation definition is a constraining profile on the base.)
-
getBaseTarget
public OperationDefinition getBaseTarget()
- Returns:
baseThe 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-baseThe 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.)
-
getResource
public List<CodeType> getResource()
- Returns:
resource(The types on which this operation can be executed.)
-
setResource
public OperationDefinition setResource(List<CodeType> theResource)
- Returns:
- Returns a reference to
thisfor easy method chaining
-
hasResource
public boolean hasResource()
-
addResourceElement
public CodeType addResourceElement()
- Returns:
resource(The types on which this operation can be executed.)
-
addResource
public OperationDefinition addResource(String value)
- Parameters:
value-resource(The types on which this operation can be executed.)
-
hasResource
public boolean hasResource(String value)
- Parameters:
value-resource(The types on which this operation can be executed.)
-
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
-
hasSystemElement
public boolean hasSystemElement()
-
hasSystem
public boolean hasSystem()
-
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).
-
getTypeElement
public BooleanType getTypeElement()
- 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 specific resource id for the context).). This is the underlying object with id, value and extensions. The accessor "getType" gives direct access to the value
-
hasTypeElement
public boolean hasTypeElement()
-
hasType
public boolean hasType()
-
setTypeElement
public OperationDefinition setTypeElement(BooleanType 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 specific resource id for the context).). This is the underlying object with id, value and extensions. The accessor "getType" gives direct access to the value
-
getType
public boolean getType()
- Returns:
- 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).
-
setType
public OperationDefinition setType(boolean value)
- Parameters:
value- 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).
-
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
-
hasInstanceElement
public boolean hasInstanceElement()
-
hasInstance
public boolean hasInstance()
-
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.
-
getParameter
public List<OperationDefinition.OperationDefinitionParameterComponent> getParameter()
- Returns:
parameter(The parameters for the operation/query.)
-
setParameter
public OperationDefinition setParameter(List<OperationDefinition.OperationDefinitionParameterComponent> theParameter)
- Returns:
- Returns a reference to
thisfor easy method chaining
-
hasParameter
public boolean hasParameter()
-
addParameter
public OperationDefinition.OperationDefinitionParameterComponent addParameter()
-
addParameter
public OperationDefinition addParameter(OperationDefinition.OperationDefinitionParameterComponent t)
-
getParameterFirstRep
public OperationDefinition.OperationDefinitionParameterComponent getParameterFirstRep()
- Returns:
- The first repetition of repeating field
parameter, creating it if it does not already exist
-
getOverload
public List<OperationDefinition.OperationDefinitionOverloadComponent> getOverload()
- Returns:
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.)
-
setOverload
public OperationDefinition setOverload(List<OperationDefinition.OperationDefinitionOverloadComponent> theOverload)
- Returns:
- Returns a reference to
thisfor easy method chaining
-
hasOverload
public boolean hasOverload()
-
addOverload
public OperationDefinition.OperationDefinitionOverloadComponent addOverload()
-
addOverload
public OperationDefinition addOverload(OperationDefinition.OperationDefinitionOverloadComponent t)
-
getOverloadFirstRep
public OperationDefinition.OperationDefinitionOverloadComponent getOverloadFirstRep()
- Returns:
- The first repetition of repeating field
overload, creating it if it does not already exist
-
listChildren
protected void listChildren(List<Property> children)
- Overrides:
listChildrenin classMetadataResource
-
getNamedProperty
public Property getNamedProperty(int _hash, String _name, boolean _checkValid) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
getNamedPropertyin classMetadataResource- Throws:
org.hl7.fhir.exceptions.FHIRException
-
getProperty
public Base[] getProperty(int hash, String name, boolean checkValid) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
getPropertyin classMetadataResource- Throws:
org.hl7.fhir.exceptions.FHIRException
-
setProperty
public Base setProperty(int hash, String name, Base value) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
setPropertyin classMetadataResource- Throws:
org.hl7.fhir.exceptions.FHIRException
-
setProperty
public Base setProperty(String name, Base value) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
setPropertyin classMetadataResource- Throws:
org.hl7.fhir.exceptions.FHIRException
-
makeProperty
public Base makeProperty(int hash, String name) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
makePropertyin classMetadataResource- Throws:
org.hl7.fhir.exceptions.FHIRException
-
getTypesForProperty
public String[] getTypesForProperty(int hash, String name) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
getTypesForPropertyin classMetadataResource- Throws:
org.hl7.fhir.exceptions.FHIRException
-
addChild
public Base addChild(String name) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
addChildin classMetadataResource- Throws:
org.hl7.fhir.exceptions.FHIRException
-
fhirType
public String fhirType()
- Specified by:
fhirTypein interfaceorg.hl7.fhir.instance.model.api.IBase- Overrides:
fhirTypein classMetadataResource
-
copy
public OperationDefinition copy()
- Specified by:
copyin classMetadataResource
-
typedCopy
protected OperationDefinition typedCopy()
-
equalsDeep
public boolean equalsDeep(Base other_)
- Overrides:
equalsDeepin classMetadataResource
-
equalsShallow
public boolean equalsShallow(Base other_)
- Overrides:
equalsShallowin classMetadataResource
-
isEmpty
public boolean isEmpty()
- Specified by:
isEmptyin interfaceorg.hl7.fhir.instance.model.api.IBase- Overrides:
isEmptyin classMetadataResource
-
getResourceType
public ResourceType getResourceType()
- Specified by:
getResourceTypein classResource
-
-