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
- See Also:
-
Nested Class Summary
Modifier and TypeClassDescriptionstatic class
static class
static class
static class
static enum
static class
static enum
static class
-
Field Summary
Modifier and TypeFieldDescriptionprotected BooleanType
Whether the operation affects state.protected CanonicalType
Indicates that this operation definition is a constraining profile on the base.static final ca.uhn.fhir.rest.gclient.ReferenceClientParam
Fluent Client search parameter constant for baseprotected CodeType
The name used to invoke the operation.static final ca.uhn.fhir.rest.gclient.TokenClientParam
Fluent Client search parameter constant for codeprotected MarkdownType
Additional information about how to use this operation or named query.static final ca.uhn.fhir.rest.gclient.TokenClientParam
Fluent Client search parameter constant for contextstatic final ca.uhn.fhir.rest.gclient.QuantityClientParam
Fluent Client search parameter constant for context-quantitystatic final ca.uhn.fhir.rest.gclient.TokenClientParam
Fluent Client search parameter constant for context-typestatic final ca.uhn.fhir.rest.gclient.CompositeClientParam
<ca.uhn.fhir.rest.gclient.TokenClientParam, ca.uhn.fhir.rest.gclient.QuantityClientParam> Fluent Client search parameter constant for context-type-quantitystatic final ca.uhn.fhir.rest.gclient.CompositeClientParam
<ca.uhn.fhir.rest.gclient.TokenClientParam, ca.uhn.fhir.rest.gclient.TokenClientParam> Fluent Client search parameter constant for context-type-valuestatic final ca.uhn.fhir.rest.gclient.DateClientParam
Fluent Client search parameter constant for datestatic final ca.uhn.fhir.rest.gclient.StringClientParam
Fluent Client search parameter constant for descriptionstatic final ca.uhn.fhir.model.api.Include
Constant for fluent queries to be used to add include statements.static final ca.uhn.fhir.model.api.Include
Constant for fluent queries to be used to add include statements.static final ca.uhn.fhir.model.api.Include
Constant for fluent queries to be used to add include statements.static final ca.uhn.fhir.rest.gclient.ReferenceClientParam
Fluent Client search parameter constant for input-profileprotected CanonicalType
Additional validation information for the in parameters - a single profile that covers all the parameters.protected BooleanType
Indicates whether this operation can be invoked on a particular instance of one of the given types.static final ca.uhn.fhir.rest.gclient.TokenClientParam
Fluent Client search parameter constant for instancestatic final ca.uhn.fhir.rest.gclient.TokenClientParam
Fluent Client search parameter constant for jurisdictionprotected Enumeration
<OperationDefinition.OperationKind> Whether this is an operation or a named query.static final ca.uhn.fhir.rest.gclient.TokenClientParam
Fluent Client search parameter constant for kindstatic final ca.uhn.fhir.rest.gclient.StringClientParam
Fluent Client search parameter constant for namestatic final ca.uhn.fhir.rest.gclient.ReferenceClientParam
Fluent Client search parameter constant for output-profileprotected CanonicalType
Additional validation information for the out parameters - a single profile that covers all the parameters.Defines an appropriate combination of parameters to use when invoking this operation, to help code generators when generating overloaded parameter sets for this operation.The parameters for the operation/query.static final ca.uhn.fhir.rest.gclient.StringClientParam
Fluent Client search parameter constant for publisherprotected MarkdownType
Explanation of why this operation definition is needed and why it has been designed as it has.The types on which this operation can be executed.static final String
Search parameter: basestatic final String
Search parameter: codestatic final String
Search parameter: contextstatic final String
Search parameter: context-quantitystatic final String
Search parameter: context-typestatic final String
Search parameter: context-type-quantitystatic final String
Search parameter: context-type-valuestatic final String
Search parameter: datestatic final String
Search parameter: descriptionstatic final String
Search parameter: input-profilestatic final String
Search parameter: instancestatic final String
Search parameter: jurisdictionstatic final String
Search parameter: kindstatic final String
Search parameter: namestatic final String
Search parameter: output-profilestatic final String
Search parameter: publisherstatic final String
Search parameter: statusstatic final String
Search parameter: systemstatic final String
Search parameter: titlestatic final String
Search parameter: typestatic final String
Search parameter: urlstatic final String
Search parameter: versionstatic final ca.uhn.fhir.rest.gclient.TokenClientParam
Fluent Client search parameter constant for statusprotected BooleanType
Indicates whether this operation or named query can be invoked at the system level (e.g.static final ca.uhn.fhir.rest.gclient.TokenClientParam
Fluent Client search parameter constant for systemstatic final ca.uhn.fhir.rest.gclient.StringClientParam
Fluent Client search parameter constant for titleprotected BooleanType
Indicates whether this operation or named query can be invoked at the resource type level for any given resource type level (e.g.static final ca.uhn.fhir.rest.gclient.TokenClientParam
Fluent Client search parameter constant for typestatic final ca.uhn.fhir.rest.gclient.UriClientParam
Fluent Client search parameter constant for urlstatic final ca.uhn.fhir.rest.gclient.TokenClientParam
Fluent Client search parameter constant for versionFields inherited from class org.hl7.fhir.r4.model.MetadataResource
contact, date, description, experimental, jurisdiction, name, publisher, status, title, url, useContext, version
Fields inherited from class org.hl7.fhir.r4.model.DomainResource
contained, extension, modifierExtension, text
Fields inherited from class org.hl7.fhir.r4.model.Resource
id, implicitRules, language, meta
Fields inherited from interface org.hl7.fhir.instance.model.api.IAnyResource
RES_ID, RES_LAST_UPDATED, RES_PROFILE, RES_SECURITY, RES_TAG, SP_RES_ID, SP_RES_LAST_UPDATED, SP_RES_PROFILE, SP_RES_SECURITY, SP_RES_TAG
Fields inherited from interface org.hl7.fhir.instance.model.api.IBaseResource
INCLUDE_ALL, WILDCARD_ALL_SET
-
Constructor Summary
ConstructorDescriptionConstructorOperationDefinition
(StringType name, Enumeration<Enumerations.PublicationStatus> status, Enumeration<OperationDefinition.OperationKind> kind, CodeType code, BooleanType system, BooleanType type, BooleanType instance) Constructor -
Method Summary
Modifier and TypeMethodDescriptionaddResource
(String value) copy()
void
boolean
equalsDeep
(Base other_) boolean
equalsShallow
(Base other_) fhirType()
boolean
getBase()
getCode()
getDate()
boolean
boolean
getKind()
getName()
getNamedProperty
(int _hash, String _name, boolean _checkValid) Base[]
getProperty
(int hash, String name, boolean checkValid) boolean
getTitle()
boolean
getType()
String[]
getTypesForProperty
(int hash, String name) getUrl()
boolean
boolean
boolean
hasBase()
boolean
boolean
hasCode()
boolean
boolean
boolean
boolean
boolean
hasDate()
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
hasKind()
boolean
boolean
hasName()
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
hasResource
(String value) boolean
boolean
boolean
boolean
boolean
hasTitle()
boolean
boolean
hasType()
boolean
boolean
hasUrl()
boolean
boolean
boolean
boolean
boolean
isEmpty()
protected void
listChildren
(List<Property> children) makeProperty
(int hash, String name) void
removeChild
(String name, Base value) setAffectsState
(boolean value) setBaseElement
(CanonicalType value) setCodeElement
(CodeType value) setComment
(String value) setCommentElement
(MarkdownType value) setContact
(List<ContactDetail> theContact) setDateElement
(DateTimeType value) setDescription
(String value) setExperimental
(boolean value) setInputProfile
(String value) setInstance
(boolean value) setInstanceElement
(BooleanType value) setJurisdiction
(List<CodeableConcept> theJurisdiction) setNameElement
(StringType value) setOutputProfile
(String value) setProperty
(int hash, String name, Base value) setProperty
(String name, Base value) setPublisher
(String value) setPublisherElement
(StringType value) setPurpose
(String value) setPurposeElement
(MarkdownType value) setResource
(List<CodeType> theResource) setSystem
(boolean value) setSystemElement
(BooleanType value) setTitleElement
(StringType value) setType
(boolean value) setTypeElement
(BooleanType value) setUrlElement
(UriType value) setUseContext
(List<UsageContext> theUseContext) setVersion
(String value) setVersionElement
(StringType value) protected OperationDefinition
Methods inherited from class org.hl7.fhir.r4.model.MetadataResource
copyValues, present, toString
Methods inherited from class org.hl7.fhir.r4.model.DomainResource
addContained, addExtension, addExtension, addExtension, addModifierExtension, addModifierExtension, checkNoModifiers, copyValues, getContained, getContained, getExtension, getExtensionByUrl, getExtensionsByUrl, getModifierExtension, getModifierExtensionsByUrl, getText, hasContained, hasExtension, hasExtension, hasModifierExtension, hasText, setContained, setExtension, setModifierExtension, setText
Methods inherited from class org.hl7.fhir.r4.model.Resource
copyValues, getId, getIdBase, getIdElement, getIdPart, getImplicitRules, getImplicitRulesElement, getLanguage, 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.r4.model.BaseResource
getStructureFhirVersionEnum, isResource, setId
Methods inherited from class org.hl7.fhir.r4.model.Base
castToAddress, castToAnnotation, castToAttachment, castToBase64Binary, castToBoolean, castToCanonical, castToCode, castToCodeableConcept, castToCoding, castToContactDetail, castToContactPoint, castToContributor, castToDataRequirement, castToDate, castToDateTime, castToDecimal, castToDosage, castToDuration, castToElementDefinition, castToExpression, castToExtension, castToHumanName, castToId, castToIdentifier, castToInstant, castToInteger, castToMarkdown, castToMarketingStatus, castToMeta, castToMoney, castToNarrative, castToOid, castToParameterDefinition, castToPeriod, castToPopulation, castToPositiveInt, castToProdCharacteristic, castToProductShelfLife, castToQuantity, castToRange, castToRatio, castToReference, castToRelatedArtifact, castToResource, castToSampledData, castToSignature, castToSimpleQuantity, castToString, castToSubstanceAmount, castToTime, castToTiming, castToTriggerDefinition, castToType, castToUnsignedInt, castToUri, castToUrl, castToUsageContext, castToXhtml, castToXhtmlString, children, clearUserData, compareDeep, compareDeep, compareDeep, compareDeep, compareValues, compareValues, copyValues, dateTimeValue, equals, getChildByName, getFormatCommentsPost, getFormatCommentsPre, getNamedProperty, getUserData, getUserInt, getUserString, getXhtml, hasFormatComment, hasPrimitiveValue, hasType, hasUserData, isBooleanPrimitive, isDateTime, 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
Methods inherited from interface org.hl7.fhir.instance.model.api.IBase
getFormatCommentsPost, getFormatCommentsPre, hasFormatComment
Methods inherited from interface org.hl7.fhir.instance.model.api.IBaseResource
getMeta, getStructureFhirVersionEnum, isDeleted, setId
-
Field Details
-
kind
Whether this is an operation or a named query. -
purpose
Explanation of why this operation definition is needed and why it has been designed as it has. -
affectsState
Whether the operation affects state. Side effects such as producing audit trail entries do not count as 'affecting state'. -
code
The name used to invoke the operation. -
comment
Additional information about how to use this operation or named query. -
base
Indicates that this operation definition is a constraining profile on the base. -
resource
The types on which this operation can be executed. -
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
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
Indicates whether this operation can be invoked on a particular instance of one of the given types. -
inputProfile
Additional validation information for the in parameters - a single profile that covers all the parameters. The profile is a constraint on the parameters resource as a whole. -
outputProfile
Additional validation information for the out parameters - a single profile that covers all the parameters. The profile is a constraint on the parameters resource. -
parameter
The parameters for the operation/query. -
overload
Defines an appropriate combination of parameters to use when invoking this operation, to help code generators when generating overloaded parameter sets for this operation. -
SP_DATE
Search parameter: dateDescription: The operation definition publication date
Type: date
Path: OperationDefinition.date
- See Also:
-
DATE
Fluent Client search parameter constant for dateDescription: The operation definition publication date
Type: date
Path: OperationDefinition.date
-
SP_CODE
Search parameter: codeDescription: Name used to invoke the operation
Type: token
Path: OperationDefinition.code
- See Also:
-
CODE
Fluent Client search parameter constant for codeDescription: Name used to invoke the operation
Type: token
Path: OperationDefinition.code
-
SP_INSTANCE
Search parameter: instanceDescription: Invoke on an instance?
Type: token
Path: OperationDefinition.instance
- See Also:
-
INSTANCE
Fluent Client search parameter constant for instanceDescription: Invoke on an instance?
Type: token
Path: OperationDefinition.instance
-
SP_CONTEXT_TYPE_VALUE
Search parameter: context-type-valueDescription: A use context type and value assigned to the operation definition
Type: composite
Path:
- See Also:
-
CONTEXT_TYPE_VALUE
public static final ca.uhn.fhir.rest.gclient.CompositeClientParam<ca.uhn.fhir.rest.gclient.TokenClientParam,ca.uhn.fhir.rest.gclient.TokenClientParam> CONTEXT_TYPE_VALUEFluent Client search parameter constant for context-type-valueDescription: A use context type and value assigned to the operation definition
Type: composite
Path:
-
SP_KIND
Search parameter: kindDescription: operation | query
Type: token
Path: OperationDefinition.kind
- See Also:
-
KIND
Fluent Client search parameter constant for kindDescription: operation | query
Type: token
Path: OperationDefinition.kind
-
SP_JURISDICTION
Search parameter: jurisdictionDescription: Intended jurisdiction for the operation definition
Type: token
Path: OperationDefinition.jurisdiction
- See Also:
-
JURISDICTION
Fluent Client search parameter constant for jurisdictionDescription: Intended jurisdiction for the operation definition
Type: token
Path: OperationDefinition.jurisdiction
-
SP_DESCRIPTION
Search parameter: descriptionDescription: The description of the operation definition
Type: string
Path: OperationDefinition.description
- See Also:
-
DESCRIPTION
Fluent Client search parameter constant for descriptionDescription: The description of the operation definition
Type: string
Path: OperationDefinition.description
-
SP_CONTEXT_TYPE
Search parameter: context-typeDescription: A type of use context assigned to the operation definition
Type: token
Path: OperationDefinition.useContext.code
- See Also:
-
CONTEXT_TYPE
Fluent Client search parameter constant for context-typeDescription: A type of use context assigned to the operation definition
Type: token
Path: OperationDefinition.useContext.code
-
SP_TITLE
Search parameter: titleDescription: The human-friendly name of the operation definition
Type: string
Path: OperationDefinition.title
- See Also:
-
TITLE
Fluent Client search parameter constant for titleDescription: The human-friendly name of the operation definition
Type: string
Path: OperationDefinition.title
-
SP_TYPE
Search parameter: typeDescription: Invoke at the type level?
Type: token
Path: OperationDefinition.type
- See Also:
-
TYPE
Fluent Client search parameter constant for typeDescription: Invoke at the type level?
Type: token
Path: OperationDefinition.type
-
SP_VERSION
Search parameter: versionDescription: The business version of the operation definition
Type: token
Path: OperationDefinition.version
- See Also:
-
VERSION
Fluent Client search parameter constant for versionDescription: The business version of the operation definition
Type: token
Path: OperationDefinition.version
-
SP_URL
Search parameter: urlDescription: The uri that identifies the operation definition
Type: uri
Path: OperationDefinition.url
- See Also:
-
URL
Fluent Client search parameter constant for urlDescription: The uri that identifies the operation definition
Type: uri
Path: OperationDefinition.url
-
SP_CONTEXT_QUANTITY
Search parameter: context-quantityDescription: A quantity- or range-valued use context assigned to the operation definition
Type: quantity
Path: OperationDefinition.useContext.valueQuantity, OperationDefinition.useContext.valueRange
- See Also:
-
CONTEXT_QUANTITY
Fluent Client search parameter constant for context-quantityDescription: A quantity- or range-valued use context assigned to the operation definition
Type: quantity
Path: OperationDefinition.useContext.valueQuantity, OperationDefinition.useContext.valueRange
-
SP_INPUT_PROFILE
Search parameter: input-profileDescription: Validation information for in parameters
Type: reference
Path: OperationDefinition.inputProfile
- See Also:
-
INPUT_PROFILE
Fluent Client search parameter constant for input-profileDescription: Validation information for in parameters
Type: reference
Path: OperationDefinition.inputProfile
-
INCLUDE_INPUT_PROFILE
Constant for fluent queries to be used to add include statements. Specifies the path value of "OperationDefinition:input-profile". -
SP_OUTPUT_PROFILE
Search parameter: output-profileDescription: Validation information for out parameters
Type: reference
Path: OperationDefinition.outputProfile
- See Also:
-
OUTPUT_PROFILE
Fluent Client search parameter constant for output-profileDescription: Validation information for out parameters
Type: reference
Path: OperationDefinition.outputProfile
-
INCLUDE_OUTPUT_PROFILE
Constant for fluent queries to be used to add include statements. Specifies the path value of "OperationDefinition:output-profile". -
SP_SYSTEM
Search parameter: systemDescription: Invoke at the system level?
Type: token
Path: OperationDefinition.system
- See Also:
-
SYSTEM
Fluent Client search parameter constant for systemDescription: Invoke at the system level?
Type: token
Path: OperationDefinition.system
-
SP_NAME
Search parameter: nameDescription: Computationally friendly name of the operation definition
Type: string
Path: OperationDefinition.name
- See Also:
-
NAME
Fluent Client search parameter constant for nameDescription: Computationally friendly name of the operation definition
Type: string
Path: OperationDefinition.name
-
SP_CONTEXT
Search parameter: contextDescription: A use context assigned to the operation definition
Type: token
Path: OperationDefinition.useContext.valueCodeableConcept
- See Also:
-
CONTEXT
Fluent Client search parameter constant for contextDescription: A use context assigned to the operation definition
Type: token
Path: OperationDefinition.useContext.valueCodeableConcept
-
SP_PUBLISHER
Search parameter: publisherDescription: Name of the publisher of the operation definition
Type: string
Path: OperationDefinition.publisher
- See Also:
-
PUBLISHER
Fluent Client search parameter constant for publisherDescription: Name of the publisher of the operation definition
Type: string
Path: OperationDefinition.publisher
-
SP_CONTEXT_TYPE_QUANTITY
Search parameter: context-type-quantityDescription: A use context type and quantity- or range-based value assigned to the operation definition
Type: composite
Path:
- See Also:
-
CONTEXT_TYPE_QUANTITY
public static final ca.uhn.fhir.rest.gclient.CompositeClientParam<ca.uhn.fhir.rest.gclient.TokenClientParam,ca.uhn.fhir.rest.gclient.QuantityClientParam> CONTEXT_TYPE_QUANTITYFluent Client search parameter constant for context-type-quantityDescription: A use context type and quantity- or range-based value assigned to the operation definition
Type: composite
Path:
-
SP_STATUS
Search parameter: statusDescription: The current status of the operation definition
Type: token
Path: OperationDefinition.status
- See Also:
-
STATUS
Fluent Client search parameter constant for statusDescription: The current status of the operation definition
Type: token
Path: OperationDefinition.status
-
SP_BASE
Search parameter: baseDescription: Marks this as a profile of the base
Type: reference
Path: OperationDefinition.base
- See Also:
-
BASE
Fluent Client search parameter constant for baseDescription: Marks this as a profile of the base
Type: reference
Path: OperationDefinition.base
-
INCLUDE_BASE
Constant for fluent queries to be used to add include statements. Specifies the path value of "OperationDefinition:base".
-
-
Constructor Details
-
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 Details
-
getUrlElement
- Overrides:
getUrlElement
in 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; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which at which an authoritative instance of this operation definition is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the operation definition is stored on different servers.). This is the underlying object with id, value and extensions. The accessor "getUrl" gives direct access to the value
-
hasUrlElement
- Overrides:
hasUrlElement
in classMetadataResource
-
hasUrl
- Overrides:
hasUrl
in classMetadataResource
-
setUrlElement
- Overrides:
setUrlElement
in 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; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which at which an authoritative instance of this operation definition is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the operation definition is stored on different servers.). This is the underlying object with id, value and extensions. The accessor "getUrl" gives direct access to the value
-
getUrl
- Overrides:
getUrl
in 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; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which at which an authoritative instance of this operation definition is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the operation definition is stored on different servers.
-
setUrl
- Overrides:
setUrl
in 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; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which at which an authoritative instance of this operation definition is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the operation definition is stored on different servers.
-
getVersionElement
- Overrides:
getVersionElement
in 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
- Overrides:
hasVersionElement
in classMetadataResource
-
hasVersion
- Overrides:
hasVersion
in classMetadataResource
-
setVersionElement
- Overrides:
setVersionElement
in 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
- Overrides:
getVersion
in 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
- Overrides:
setVersion
in 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
- Overrides:
getNameElement
in 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
- Overrides:
hasNameElement
in classMetadataResource
-
hasName
- Overrides:
hasName
in classMetadataResource
-
setNameElement
- Overrides:
setNameElement
in 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
- Overrides:
getName
in 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
- Overrides:
setName
in 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.
-
getTitleElement
- Overrides:
getTitleElement
in classMetadataResource
- Returns:
MetadataResource.title
(A short, descriptive, user-friendly title for the operation definition.). This is the underlying object with id, value and extensions. The accessor "getTitle" gives direct access to the value
-
hasTitleElement
- Overrides:
hasTitleElement
in classMetadataResource
-
hasTitle
- Overrides:
hasTitle
in classMetadataResource
-
setTitleElement
- Overrides:
setTitleElement
in classMetadataResource
- Parameters:
value
-MetadataResource.title
(A short, descriptive, user-friendly title for the operation definition.). This is the underlying object with id, value and extensions. The accessor "getTitle" gives direct access to the value
-
getTitle
- Overrides:
getTitle
in classMetadataResource
- Returns:
- A short, descriptive, user-friendly title for the operation definition.
-
setTitle
- Overrides:
setTitle
in classMetadataResource
- Parameters:
value
- A short, descriptive, user-friendly title for the operation definition.
-
getStatusElement
- Overrides:
getStatusElement
in 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
- Overrides:
hasStatusElement
in classMetadataResource
-
hasStatus
- Overrides:
hasStatus
in classMetadataResource
-
setStatusElement
- Overrides:
setStatusElement
in 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
- Overrides:
getStatus
in classMetadataResource
- Returns:
- The status of this operation definition. Enables tracking the life-cycle of the content.
-
setStatus
- Overrides:
setStatus
in classMetadataResource
- Parameters:
value
- The status of this operation definition. Enables tracking the life-cycle of the content.
-
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
-
hasKind
-
setKindElement
- 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
- Returns:
- Whether this is an operation or a named query.
-
setKind
- Parameters:
value
- Whether this is an operation or a named query.
-
getExperimentalElement
- Overrides:
getExperimentalElement
in 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
- Overrides:
hasExperimentalElement
in classMetadataResource
-
hasExperimental
- Overrides:
hasExperimental
in classMetadataResource
-
setExperimentalElement
- Overrides:
setExperimentalElement
in 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
- Overrides:
getExperimental
in 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
- Overrides:
setExperimental
in 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
- Overrides:
getDateElement
in classMetadataResource
- Returns:
MetadataResource.date
(The date (and optionally time) when the operation definition was published. The date must change 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
- Overrides:
hasDateElement
in classMetadataResource
-
hasDate
- Overrides:
hasDate
in classMetadataResource
-
setDateElement
- Overrides:
setDateElement
in classMetadataResource
- Parameters:
value
-MetadataResource.date
(The date (and optionally time) when the operation definition was published. The date must change 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
- Overrides:
getDate
in classMetadataResource
- Returns:
- The date (and optionally time) when the operation definition was published. The date must change 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
- Overrides:
setDate
in classMetadataResource
- Parameters:
value
- The date (and optionally time) when the operation definition was published. The date must change 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
- Overrides:
getPublisherElement
in classMetadataResource
- Returns:
MetadataResource.publisher
(The name of the organization or individual 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
- Overrides:
hasPublisherElement
in classMetadataResource
-
hasPublisher
- Overrides:
hasPublisher
in classMetadataResource
-
setPublisherElement
- Overrides:
setPublisherElement
in classMetadataResource
- Parameters:
value
-MetadataResource.publisher
(The name of the organization or individual 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
- Overrides:
getPublisher
in classMetadataResource
- Returns:
- The name of the organization or individual that published the operation definition.
-
setPublisher
- Overrides:
setPublisher
in classMetadataResource
- Parameters:
value
- The name of the organization or individual that published the operation definition.
-
getContact
- Overrides:
getContact
in classMetadataResource
- Returns:
MetadataResource.contact
(Contact details to assist a user in finding and communicating with the publisher.)
-
setContact
- Overrides:
setContact
in classMetadataResource
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasContact
- Overrides:
hasContact
in classMetadataResource
-
addContact
- Overrides:
addContact
in classMetadataResource
-
addContact
- Overrides:
addContact
in classMetadataResource
-
getContactFirstRep
- Overrides:
getContactFirstRep
in classMetadataResource
- Returns:
- The first repetition of repeating field
MetadataResource.contact
, creating it if it does not already exist
-
getDescriptionElement
- Overrides:
getDescriptionElement
in 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
- Overrides:
hasDescriptionElement
in classMetadataResource
-
hasDescription
- Overrides:
hasDescription
in classMetadataResource
-
setDescriptionElement
- Overrides:
setDescriptionElement
in 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
- Overrides:
getDescription
in classMetadataResource
- Returns:
- A free text natural language description of the operation definition from a consumer's perspective.
-
setDescription
- Overrides:
setDescription
in classMetadataResource
- Parameters:
value
- A free text natural language description of the operation definition from a consumer's perspective.
-
getUseContext
- Overrides:
getUseContext
in classMetadataResource
- Returns:
MetadataResource.useContext
(The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate operation definition instances.)
-
setUseContext
- Overrides:
setUseContext
in classMetadataResource
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasUseContext
- Overrides:
hasUseContext
in classMetadataResource
-
addUseContext
- Overrides:
addUseContext
in classMetadataResource
-
addUseContext
- Overrides:
addUseContext
in classMetadataResource
-
getUseContextFirstRep
- Overrides:
getUseContextFirstRep
in classMetadataResource
- Returns:
- The first repetition of repeating field
MetadataResource.useContext
, creating it if it does not already exist
-
getJurisdiction
- Overrides:
getJurisdiction
in classMetadataResource
- Returns:
MetadataResource.jurisdiction
(A legal or geographic region in which the operation definition is intended to be used.)
-
setJurisdiction
- Overrides:
setJurisdiction
in classMetadataResource
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasJurisdiction
- Overrides:
hasJurisdiction
in classMetadataResource
-
addJurisdiction
- Overrides:
addJurisdiction
in classMetadataResource
-
addJurisdiction
- Overrides:
addJurisdiction
in classMetadataResource
-
getJurisdictionFirstRep
- Overrides:
getJurisdictionFirstRep
in classMetadataResource
- Returns:
- The first repetition of repeating field
MetadataResource.jurisdiction
, creating it if it does not already exist
-
getPurposeElement
- Returns:
purpose
(Explanation 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
-
hasPurpose
-
setPurposeElement
- Parameters:
value
-purpose
(Explanation 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
- Returns:
- Explanation of why this operation definition is needed and why it has been designed as it has.
-
setPurpose
- Parameters:
value
- Explanation of why this operation definition is needed and why it has been designed as it has.
-
getAffectsStateElement
- Returns:
affectsState
(Whether the operation affects state. Side effects such as producing audit trail entries do not count as 'affecting state'.). This is the underlying object with id, value and extensions. The accessor "getAffectsState" gives direct access to the value
-
hasAffectsStateElement
-
hasAffectsState
-
setAffectsStateElement
- Parameters:
value
-affectsState
(Whether the operation affects state. Side effects such as producing audit trail entries do not count as 'affecting state'.). This is the underlying object with id, value and extensions. The accessor "getAffectsState" gives direct access to the value
-
getAffectsState
- Returns:
- Whether the operation affects state. Side effects such as producing audit trail entries do not count as 'affecting state'.
-
setAffectsState
- Parameters:
value
- Whether the operation affects state. Side effects such as producing audit trail entries do not count as 'affecting state'.
-
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
-
hasCode
-
setCodeElement
- 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
- Returns:
- The name used to invoke the operation.
-
setCode
- Parameters:
value
- The name used to invoke the operation.
-
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
-
hasComment
-
setCommentElement
- 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
- Returns:
- Additional information about how to use this operation or named query.
-
setComment
- Parameters:
value
- Additional information about how to use this operation or named query.
-
getBaseElement
- Returns:
base
(Indicates that this operation definition is a constraining profile on the base.). This is the underlying object with id, value and extensions. The accessor "getBase" gives direct access to the value
-
hasBaseElement
-
hasBase
-
setBaseElement
- Parameters:
value
-base
(Indicates that this operation definition is a constraining profile on the base.). This is the underlying object with id, value and extensions. The accessor "getBase" gives direct access to the value
-
getBase
- Returns:
- Indicates that this operation definition is a constraining profile on the base.
-
setBase
- Parameters:
value
- Indicates that this operation definition is a constraining profile on the base.
-
getResource
- Returns:
resource
(The types on which this operation can be executed.)
-
setResource
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasResource
-
addResourceElement
- Returns:
resource
(The types on which this operation can be executed.)
-
addResource
- Parameters:
value
-resource
(The types on which this operation can be executed.)
-
hasResource
- Parameters:
value
-resource
(The types on which this operation can be executed.)
-
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
-
hasSystem
-
setSystemElement
- 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
- 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
- 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
- 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
-
hasType
-
setTypeElement
- 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
- 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
- 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
- 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
-
hasInstance
-
setInstanceElement
- 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
- Returns:
- Indicates whether this operation can be invoked on a particular instance of one of the given types.
-
setInstance
- Parameters:
value
- Indicates whether this operation can be invoked on a particular instance of one of the given types.
-
getInputProfileElement
- Returns:
inputProfile
(Additional validation information for the in parameters - a single profile that covers all the parameters. The profile is a constraint on the parameters resource as a whole.). This is the underlying object with id, value and extensions. The accessor "getInputProfile" gives direct access to the value
-
hasInputProfileElement
-
hasInputProfile
-
setInputProfileElement
- Parameters:
value
-inputProfile
(Additional validation information for the in parameters - a single profile that covers all the parameters. The profile is a constraint on the parameters resource as a whole.). This is the underlying object with id, value and extensions. The accessor "getInputProfile" gives direct access to the value
-
getInputProfile
- Returns:
- Additional validation information for the in parameters - a single profile that covers all the parameters. The profile is a constraint on the parameters resource as a whole.
-
setInputProfile
- Parameters:
value
- Additional validation information for the in parameters - a single profile that covers all the parameters. The profile is a constraint on the parameters resource as a whole.
-
getOutputProfileElement
- Returns:
outputProfile
(Additional validation information for the out parameters - a single profile that covers all the parameters. The profile is a constraint on the parameters resource.). This is the underlying object with id, value and extensions. The accessor "getOutputProfile" gives direct access to the value
-
hasOutputProfileElement
-
hasOutputProfile
-
setOutputProfileElement
- Parameters:
value
-outputProfile
(Additional validation information for the out parameters - a single profile that covers all the parameters. The profile is a constraint on the parameters resource.). This is the underlying object with id, value and extensions. The accessor "getOutputProfile" gives direct access to the value
-
getOutputProfile
- Returns:
- Additional validation information for the out parameters - a single profile that covers all the parameters. The profile is a constraint on the parameters resource.
-
setOutputProfile
- Parameters:
value
- Additional validation information for the out parameters - a single profile that covers all the parameters. The profile is a constraint on the parameters resource.
-
getParameter
- Returns:
parameter
(The parameters for the operation/query.)
-
setParameter
public OperationDefinition setParameter(List<OperationDefinition.OperationDefinitionParameterComponent> theParameter) - Returns:
- Returns a reference to
this
for easy method chaining
-
hasParameter
-
addParameter
-
addParameter
-
getParameterFirstRep
- Returns:
- The first repetition of repeating field
parameter
, creating it if it does not already exist
-
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
this
for easy method chaining
-
hasOverload
-
addOverload
-
addOverload
-
getOverloadFirstRep
- Returns:
- The first repetition of repeating field
overload
, creating it if it does not already exist
-
listChildren
- Overrides:
listChildren
in classMetadataResource
-
getNamedProperty
public Property getNamedProperty(int _hash, String _name, boolean _checkValid) throws org.hl7.fhir.exceptions.FHIRException - Overrides:
getNamedProperty
in classDomainResource
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
getProperty
public Base[] getProperty(int hash, String name, boolean checkValid) throws org.hl7.fhir.exceptions.FHIRException - Overrides:
getProperty
in classMetadataResource
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
setProperty
public Base setProperty(int hash, String name, Base value) throws org.hl7.fhir.exceptions.FHIRException - Overrides:
setProperty
in classMetadataResource
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
setProperty
- Overrides:
setProperty
in classMetadataResource
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
removeChild
- Overrides:
removeChild
in classMetadataResource
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
makeProperty
- Overrides:
makeProperty
in classMetadataResource
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
getTypesForProperty
public String[] getTypesForProperty(int hash, String name) throws org.hl7.fhir.exceptions.FHIRException - Overrides:
getTypesForProperty
in classMetadataResource
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
addChild
- Overrides:
addChild
in classMetadataResource
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
fhirType
- Specified by:
fhirType
in interfaceorg.hl7.fhir.instance.model.api.IBase
- Overrides:
fhirType
in classMetadataResource
-
copy
- Specified by:
copy
in classMetadataResource
-
copyValues
-
typedCopy
-
equalsDeep
- Overrides:
equalsDeep
in classMetadataResource
-
equalsShallow
- Overrides:
equalsShallow
in classMetadataResource
-
isEmpty
- Specified by:
isEmpty
in interfaceorg.hl7.fhir.instance.model.api.IBase
- Overrides:
isEmpty
in classMetadataResource
-
getResourceType
- Specified by:
getResourceType
in classResource
-