Package org.hl7.fhir.r4.model

Class OperationDefinition

java.lang.Object

org.hl7.fhir.r4.model.Base

org.hl7.fhir.r4.model.BaseResource

org.hl7.fhir.r4.model.Resource

org.hl7.fhir.r4.model.DomainResource

org.hl7.fhir.r4.model.MetadataResource

org.hl7.fhir.r4.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 class	OperationDefinition.OperationDefinitionOverloadComponent
static class	OperationDefinition.OperationDefinitionParameterBindingComponent
static class	OperationDefinition.OperationDefinitionParameterComponent
static class	OperationDefinition.OperationDefinitionParameterReferencedFromComponent
static enum	OperationDefinition.OperationKind
static class	OperationDefinition.OperationKindEnumFactory
static enum	OperationDefinition.OperationParameterUse
static class	OperationDefinition.OperationParameterUseEnumFactory

Field Summary

Fields

Modifier and Type	Field	Description
protected BooleanType	affectsState	Whether the operation affects state.
protected CanonicalType	base	Indicates that this operation definition is a constraining profile on the base.
static final ca.uhn.fhir.rest.gclient.ReferenceClientParam	BASE	Fluent Client search parameter constant for base
protected CodeType	code	The name used to invoke the operation.
static final ca.uhn.fhir.rest.gclient.TokenClientParam	CODE	Fluent Client search parameter constant for code
protected MarkdownType	comment	Additional information about how to use this operation or named query.
static final ca.uhn.fhir.rest.gclient.TokenClientParam	CONTEXT	Fluent Client search parameter constant for context
static final ca.uhn.fhir.rest.gclient.QuantityClientParam	CONTEXT_QUANTITY	Fluent Client search parameter constant for context-quantity
static final ca.uhn.fhir.rest.gclient.TokenClientParam	CONTEXT_TYPE	Fluent Client search parameter constant for context-type
static final ca.uhn.fhir.rest.gclient.CompositeClientParam<ca.uhn.fhir.rest.gclient.TokenClientParam,ca.uhn.fhir.rest.gclient.QuantityClientParam>	CONTEXT_TYPE_QUANTITY	Fluent Client search parameter constant for context-type-quantity
static final ca.uhn.fhir.rest.gclient.CompositeClientParam<ca.uhn.fhir.rest.gclient.TokenClientParam,ca.uhn.fhir.rest.gclient.TokenClientParam>	CONTEXT_TYPE_VALUE	Fluent Client search parameter constant for context-type-value
static final ca.uhn.fhir.rest.gclient.DateClientParam	DATE	Fluent Client search parameter constant for date
static final ca.uhn.fhir.rest.gclient.StringClientParam	DESCRIPTION	Fluent Client search parameter constant for description
static final ca.uhn.fhir.model.api.Include	INCLUDE_BASE	Constant for fluent queries to be used to add include statements.
static final ca.uhn.fhir.model.api.Include	INCLUDE_INPUT_PROFILE	Constant for fluent queries to be used to add include statements.
static final ca.uhn.fhir.model.api.Include	INCLUDE_OUTPUT_PROFILE	Constant for fluent queries to be used to add include statements.
static final ca.uhn.fhir.rest.gclient.ReferenceClientParam	INPUT_PROFILE	Fluent Client search parameter constant for input-profile
protected CanonicalType	inputProfile	Additional validation information for the in parameters - a single profile that covers all the parameters.
protected BooleanType	instance	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	INSTANCE	Fluent Client search parameter constant for instance
static final ca.uhn.fhir.rest.gclient.TokenClientParam	JURISDICTION	Fluent Client search parameter constant for jurisdiction
protected Enumeration<OperationDefinition.OperationKind>	kind	Whether this is an operation or a named query.
static final ca.uhn.fhir.rest.gclient.TokenClientParam	KIND	Fluent Client search parameter constant for kind
static final ca.uhn.fhir.rest.gclient.StringClientParam	NAME	Fluent Client search parameter constant for name
static final ca.uhn.fhir.rest.gclient.ReferenceClientParam	OUTPUT_PROFILE	Fluent Client search parameter constant for output-profile
protected CanonicalType	outputProfile	Additional validation information for the out parameters - a single profile that covers all the parameters.
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.
protected List<OperationDefinition.OperationDefinitionParameterComponent>	parameter	The parameters for the operation/query.
static final ca.uhn.fhir.rest.gclient.StringClientParam	PUBLISHER	Fluent Client search parameter constant for publisher
protected MarkdownType	purpose	Explanation of why this operation definition is needed and why it has been designed as it has.
protected List<CodeType>	resource	The types on which this operation can be executed.
static final String	SP_BASE	Search parameter: base
static final String	SP_CODE	Search parameter: code
static final String	SP_CONTEXT	Search parameter: context
static final String	SP_CONTEXT_QUANTITY	Search parameter: context-quantity
static final String	SP_CONTEXT_TYPE	Search parameter: context-type
static final String	SP_CONTEXT_TYPE_QUANTITY	Search parameter: context-type-quantity
static final String	SP_CONTEXT_TYPE_VALUE	Search parameter: context-type-value
static final String	SP_DATE	Search parameter: date
static final String	SP_DESCRIPTION	Search parameter: description
static final String	SP_INPUT_PROFILE	Search parameter: input-profile
static final String	SP_INSTANCE	Search parameter: instance
static final String	SP_JURISDICTION	Search parameter: jurisdiction
static final String	SP_KIND	Search parameter: kind
static final String	SP_NAME	Search parameter: name
static final String	SP_OUTPUT_PROFILE	Search parameter: output-profile
static final String	SP_PUBLISHER	Search parameter: publisher
static final String	SP_STATUS	Search parameter: status
static final String	SP_SYSTEM	Search parameter: system
static final String	SP_TITLE	Search parameter: title
static final String	SP_TYPE	Search parameter: type
static final String	SP_URL	Search parameter: url
static final String	SP_VERSION	Search parameter: version
static final ca.uhn.fhir.rest.gclient.TokenClientParam	STATUS	Fluent Client search parameter constant for status
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).
static final ca.uhn.fhir.rest.gclient.TokenClientParam	SYSTEM	Fluent Client search parameter constant for system
static final ca.uhn.fhir.rest.gclient.StringClientParam	TITLE	Fluent Client search parameter constant for title
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).
static final ca.uhn.fhir.rest.gclient.TokenClientParam	TYPE	Fluent Client search parameter constant for type
static final ca.uhn.fhir.rest.gclient.UriClientParam	URL	Fluent Client search parameter constant for url
static final ca.uhn.fhir.rest.gclient.TokenClientParam	VERSION	Fluent Client search parameter constant for version

Fields 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

Constructors

Constructor	Description
OperationDefinition()	Constructor
OperationDefinition(StringType name, Enumeration<Enumerations.PublicationStatus> status, Enumeration<OperationDefinition.OperationKind> kind, CodeType code, BooleanType system, BooleanType type, BooleanType instance)	Constructor

Method Summary

Modifier and Type	Method	Description
Base	addChild(String name)
ContactDetail	addContact()
OperationDefinition	addContact(ContactDetail t)
CodeableConcept	addJurisdiction()
OperationDefinition	addJurisdiction(CodeableConcept t)
OperationDefinition.OperationDefinitionOverloadComponent	addOverload()
OperationDefinition	addOverload(OperationDefinition.OperationDefinitionOverloadComponent t)
OperationDefinition.OperationDefinitionParameterComponent	addParameter()
OperationDefinition	addParameter(OperationDefinition.OperationDefinitionParameterComponent t)
OperationDefinition	addResource(String value)
CodeType	addResourceElement()
UsageContext	addUseContext()
OperationDefinition	addUseContext(UsageContext t)
OperationDefinition	copy()
void	copyValues(OperationDefinition dst)
boolean	equalsDeep(Base other_)
boolean	equalsShallow(Base other_)
String	fhirType()
boolean	getAffectsState()
BooleanType	getAffectsStateElement()
String	getBase()
CanonicalType	getBaseElement()
String	getCode()
CodeType	getCodeElement()
String	getComment()
MarkdownType	getCommentElement()
List<ContactDetail>	getContact()
ContactDetail	getContactFirstRep()
Date	getDate()
DateTimeType	getDateElement()
String	getDescription()
MarkdownType	getDescriptionElement()
boolean	getExperimental()
BooleanType	getExperimentalElement()
String	getInputProfile()
CanonicalType	getInputProfileElement()
boolean	getInstance()
BooleanType	getInstanceElement()
List<CodeableConcept>	getJurisdiction()
CodeableConcept	getJurisdictionFirstRep()
OperationDefinition.OperationKind	getKind()
Enumeration<OperationDefinition.OperationKind>	getKindElement()
String	getName()
Property	getNamedProperty(int _hash, String _name, boolean _checkValid)
StringType	getNameElement()
String	getOutputProfile()
CanonicalType	getOutputProfileElement()
List<OperationDefinition.OperationDefinitionOverloadComponent>	getOverload()
OperationDefinition.OperationDefinitionOverloadComponent	getOverloadFirstRep()
List<OperationDefinition.OperationDefinitionParameterComponent>	getParameter()
OperationDefinition.OperationDefinitionParameterComponent	getParameterFirstRep()
Base[]	getProperty(int hash, String name, boolean checkValid)
String	getPublisher()
StringType	getPublisherElement()
String	getPurpose()
MarkdownType	getPurposeElement()
List<CodeType>	getResource()
ResourceType	getResourceType()
Enumerations.PublicationStatus	getStatus()
Enumeration<Enumerations.PublicationStatus>	getStatusElement()
boolean	getSystem()
BooleanType	getSystemElement()
String	getTitle()
StringType	getTitleElement()
boolean	getType()
BooleanType	getTypeElement()
String[]	getTypesForProperty(int hash, String name)
String	getUrl()
UriType	getUrlElement()
List<UsageContext>	getUseContext()
UsageContext	getUseContextFirstRep()
String	getVersion()
StringType	getVersionElement()
boolean	hasAffectsState()
boolean	hasAffectsStateElement()
boolean	hasBase()
boolean	hasBaseElement()
boolean	hasCode()
boolean	hasCodeElement()
boolean	hasComment()
boolean	hasCommentElement()
boolean	hasContact()
boolean	hasDate()
boolean	hasDateElement()
boolean	hasDescription()
boolean	hasDescriptionElement()
boolean	hasExperimental()
boolean	hasExperimentalElement()
boolean	hasInputProfile()
boolean	hasInputProfileElement()
boolean	hasInstance()
boolean	hasInstanceElement()
boolean	hasJurisdiction()
boolean	hasKind()
boolean	hasKindElement()
boolean	hasName()
boolean	hasNameElement()
boolean	hasOutputProfile()
boolean	hasOutputProfileElement()
boolean	hasOverload()
boolean	hasParameter()
boolean	hasPublisher()
boolean	hasPublisherElement()
boolean	hasPurpose()
boolean	hasPurposeElement()
boolean	hasResource()
boolean	hasResource(String value)
boolean	hasStatus()
boolean	hasStatusElement()
boolean	hasSystem()
boolean	hasSystemElement()
boolean	hasTitle()
boolean	hasTitleElement()
boolean	hasType()
boolean	hasTypeElement()
boolean	hasUrl()
boolean	hasUrlElement()
boolean	hasUseContext()
boolean	hasVersion()
boolean	hasVersionElement()
boolean	isEmpty()
protected void	listChildren(List<Property> children)
Base	makeProperty(int hash, String name)
void	removeChild(String name, Base value)
OperationDefinition	setAffectsState(boolean value)
OperationDefinition	setAffectsStateElement(BooleanType value)
OperationDefinition	setBase(String value)
OperationDefinition	setBaseElement(CanonicalType value)
OperationDefinition	setCode(String value)
OperationDefinition	setCodeElement(CodeType value)
OperationDefinition	setComment(String value)
OperationDefinition	setCommentElement(MarkdownType value)
OperationDefinition	setContact(List<ContactDetail> theContact)
OperationDefinition	setDate(Date value)
OperationDefinition	setDateElement(DateTimeType value)
OperationDefinition	setDescription(String value)
OperationDefinition	setDescriptionElement(MarkdownType value)
OperationDefinition	setExperimental(boolean value)
OperationDefinition	setExperimentalElement(BooleanType value)
OperationDefinition	setInputProfile(String value)
OperationDefinition	setInputProfileElement(CanonicalType value)
OperationDefinition	setInstance(boolean value)
OperationDefinition	setInstanceElement(BooleanType value)
OperationDefinition	setJurisdiction(List<CodeableConcept> theJurisdiction)
OperationDefinition	setKind(OperationDefinition.OperationKind value)
OperationDefinition	setKindElement(Enumeration<OperationDefinition.OperationKind> value)
OperationDefinition	setName(String value)
OperationDefinition	setNameElement(StringType value)
OperationDefinition	setOutputProfile(String value)
OperationDefinition	setOutputProfileElement(CanonicalType value)
OperationDefinition	setOverload(List<OperationDefinition.OperationDefinitionOverloadComponent> theOverload)
OperationDefinition	setParameter(List<OperationDefinition.OperationDefinitionParameterComponent> theParameter)
Base	setProperty(int hash, String name, Base value)
Base	setProperty(String name, Base value)
OperationDefinition	setPublisher(String value)
OperationDefinition	setPublisherElement(StringType value)
OperationDefinition	setPurpose(String value)
OperationDefinition	setPurposeElement(MarkdownType value)
OperationDefinition	setResource(List<CodeType> theResource)
OperationDefinition	setStatus(Enumerations.PublicationStatus value)
OperationDefinition	setStatusElement(Enumeration<Enumerations.PublicationStatus> value)
OperationDefinition	setSystem(boolean value)
OperationDefinition	setSystemElement(BooleanType value)
OperationDefinition	setTitle(String value)
OperationDefinition	setTitleElement(StringType value)
OperationDefinition	setType(boolean value)
OperationDefinition	setTypeElement(BooleanType value)
OperationDefinition	setUrl(String value)
OperationDefinition	setUrlElement(UriType value)
OperationDefinition	setUseContext(List<UsageContext> theUseContext)
OperationDefinition	setVersion(String value)
OperationDefinition	setVersionElement(StringType value)
protected OperationDefinition	typedCopy()

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, getExtensionString, getExtensionString, getModifierExtension, getModifierExtensionsByUrl, getText, hasContained, hasExtension, hasExtension, hasModifierExtension, hasPrimitiveExtension, 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, getChildValueByName, getFormatCommentsPost, getFormatCommentsPre, getNamedProperty, getUserData, getUserInt, getUserString, getXhtml, hasFormatComment, hasPrimitiveValue, hasType, hasUserData, isBooleanPrimitive, isDateTime, isMetadataBased, isPrimitive, listChildrenByName, listChildrenByName, primitiveValue, setUserData, setUserDataINN, setXhtml

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

protected Enumeration<OperationDefinition.OperationKind> kind

Whether this is an operation or a named query.

purpose

protected MarkdownType purpose

Explanation of why this operation definition is needed and why it has been designed as it has.

affectsState

protected BooleanType affectsState

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

code

protected CodeType code

The name used to invoke the operation.

comment

protected MarkdownType comment

Additional information about how to use this operation or named query.

base

protected CanonicalType base

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

resource

protected List<CodeType> resource

The types on which this operation can be executed.

system

protected BooleanType system

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

type

protected BooleanType type

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

instance

protected BooleanType instance

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

inputProfile

protected CanonicalType 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

protected CanonicalType 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

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

Description: 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 date

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

SP_CODE

public static final String SP_CODE

Search parameter: code

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

See Also:

• Constant Field Values

CODE

public static final ca.uhn.fhir.rest.gclient.TokenClientParam CODE

Fluent Client search parameter constant for code

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

SP_INSTANCE

public static final String SP_INSTANCE

Search parameter: instance

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

See Also:

• Constant Field Values

INSTANCE

public static final ca.uhn.fhir.rest.gclient.TokenClientParam INSTANCE

Fluent Client search parameter constant for instance

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

SP_CONTEXT_TYPE_VALUE

public static final String SP_CONTEXT_TYPE_VALUE

Search parameter: context-type-value

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

See Also:

• Constant Field Values

CONTEXT_TYPE_VALUE

public static final ca.uhn.fhir.rest.gclient.CompositeClientParam<ca.uhn.fhir.rest.gclient.TokenClientParam,ca.uhn.fhir.rest.gclient.TokenClientParam> CONTEXT_TYPE_VALUE

Fluent Client search parameter constant for context-type-value

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

SP_KIND

public static final String SP_KIND

Search parameter: kind

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

See Also:

• Constant Field Values

KIND

public static final ca.uhn.fhir.rest.gclient.TokenClientParam KIND

Fluent Client search parameter constant for kind

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

SP_JURISDICTION

public static final String SP_JURISDICTION

Search parameter: jurisdiction

Description: 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 jurisdiction

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

SP_DESCRIPTION

public static final String SP_DESCRIPTION

Search parameter: description

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

See Also:

• Constant Field Values

DESCRIPTION

public static final ca.uhn.fhir.rest.gclient.StringClientParam DESCRIPTION

Fluent Client search parameter constant for description

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

SP_CONTEXT_TYPE

public static final String SP_CONTEXT_TYPE

Search parameter: context-type

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

See Also:

• Constant Field Values

CONTEXT_TYPE

public static final ca.uhn.fhir.rest.gclient.TokenClientParam CONTEXT_TYPE

Fluent Client search parameter constant for context-type

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

SP_TITLE

public static final String SP_TITLE

Search parameter: title

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

See Also:

• Constant Field Values

TITLE

public static final ca.uhn.fhir.rest.gclient.StringClientParam TITLE

Fluent Client search parameter constant for title

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

SP_TYPE

public static final String SP_TYPE

Search parameter: type

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

See Also:

• Constant Field Values

TYPE

public static final ca.uhn.fhir.rest.gclient.TokenClientParam TYPE

Fluent Client search parameter constant for type

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

SP_VERSION

public static final String SP_VERSION

Search parameter: version

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

See Also:

• Constant Field Values

VERSION

public static final ca.uhn.fhir.rest.gclient.TokenClientParam VERSION

Fluent Client search parameter constant for version

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

SP_URL

public static final String SP_URL

Search parameter: url

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

See Also:

• Constant Field Values

URL

public static final ca.uhn.fhir.rest.gclient.UriClientParam URL

Fluent Client search parameter constant for url

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

SP_CONTEXT_QUANTITY

public static final String SP_CONTEXT_QUANTITY

Search parameter: context-quantity

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

See Also:

• Constant Field Values

CONTEXT_QUANTITY

public static final ca.uhn.fhir.rest.gclient.QuantityClientParam CONTEXT_QUANTITY

Fluent Client search parameter constant for context-quantity

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

SP_INPUT_PROFILE

public static final String SP_INPUT_PROFILE

Search parameter: input-profile

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

See Also:

• Constant Field Values

INPUT_PROFILE

public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam INPUT_PROFILE

Fluent Client search parameter constant for input-profile

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

INCLUDE_INPUT_PROFILE

public static final ca.uhn.fhir.model.api.Include INCLUDE_INPUT_PROFILE

Constant for fluent queries to be used to add include statements. Specifies the path value of "OperationDefinition:input-profile".

SP_OUTPUT_PROFILE

public static final String SP_OUTPUT_PROFILE

Search parameter: output-profile

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

See Also:

• Constant Field Values

OUTPUT_PROFILE

public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam OUTPUT_PROFILE

Fluent Client search parameter constant for output-profile

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

INCLUDE_OUTPUT_PROFILE

public static final ca.uhn.fhir.model.api.Include INCLUDE_OUTPUT_PROFILE

Constant for fluent queries to be used to add include statements. Specifies the path value of "OperationDefinition:output-profile".

SP_SYSTEM

public static final String SP_SYSTEM

Search parameter: system

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

See Also:

• Constant Field Values

SYSTEM

public static final ca.uhn.fhir.rest.gclient.TokenClientParam SYSTEM

Fluent Client search parameter constant for system

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

SP_NAME

public static final String SP_NAME

Search parameter: name

Description: 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 name

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

SP_CONTEXT

public static final String SP_CONTEXT

Search parameter: context

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

See Also:

• Constant Field Values

CONTEXT

public static final ca.uhn.fhir.rest.gclient.TokenClientParam CONTEXT

Fluent Client search parameter constant for context

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

SP_PUBLISHER

public static final String SP_PUBLISHER

Search parameter: publisher

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

See Also:

• Constant Field Values

PUBLISHER

public static final ca.uhn.fhir.rest.gclient.StringClientParam PUBLISHER

Fluent Client search parameter constant for publisher

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

SP_CONTEXT_TYPE_QUANTITY

public static final String SP_CONTEXT_TYPE_QUANTITY

Search parameter: context-type-quantity

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

See Also:

• Constant Field Values

CONTEXT_TYPE_QUANTITY

public static final ca.uhn.fhir.rest.gclient.CompositeClientParam<ca.uhn.fhir.rest.gclient.TokenClientParam,ca.uhn.fhir.rest.gclient.QuantityClientParam> CONTEXT_TYPE_QUANTITY

Fluent Client search parameter constant for context-type-quantity

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

SP_STATUS

public static final String SP_STATUS

Search parameter: status

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

See Also:

• Constant Field Values

STATUS

public static final ca.uhn.fhir.rest.gclient.TokenClientParam STATUS

Fluent Client search parameter constant for status

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

SP_BASE

public static final String SP_BASE

Search parameter: base

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

See Also:

• Constant Field Values

BASE

public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam BASE

Fluent Client search parameter constant for base

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

INCLUDE_BASE

public static final ca.uhn.fhir.model.api.Include INCLUDE_BASE

Constant for fluent queries to be used to add include statements. Specifies the path value of "OperationDefinition:base".

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

public UriType getUrlElement()

Overrides:

getUrlElement in class MetadataResource

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

public boolean hasUrlElement()

Overrides:

hasUrlElement in class MetadataResource

hasUrl

public boolean hasUrl()

Overrides:

hasUrl in class MetadataResource

setUrlElement

public OperationDefinition setUrlElement(UriType value)

Overrides:

setUrlElement in class MetadataResource

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

public String getUrl()

Overrides:

getUrl in class MetadataResource

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

public OperationDefinition setUrl(String value)

Overrides:

setUrl in class MetadataResource

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

public StringType getVersionElement()

Overrides:

getVersionElement in class MetadataResource

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:

hasVersionElement in class MetadataResource

hasVersion

public boolean hasVersion()

Overrides:

hasVersion in class MetadataResource

setVersionElement

public OperationDefinition setVersionElement(StringType value)

Overrides:

setVersionElement in class MetadataResource

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:

getVersion in class MetadataResource

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:

setVersion in class MetadataResource

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:

getNameElement in class MetadataResource

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:

hasNameElement in class MetadataResource

hasName

public boolean hasName()

Overrides:

hasName in class MetadataResource

setNameElement

public OperationDefinition setNameElement(StringType value)

Overrides:

setNameElement in class MetadataResource

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:

getName in class MetadataResource

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:

setName in class MetadataResource

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

public StringType getTitleElement()

Overrides:

getTitleElement in class MetadataResource

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

public boolean hasTitleElement()

Overrides:

hasTitleElement in class MetadataResource

hasTitle

public boolean hasTitle()

Overrides:

hasTitle in class MetadataResource

setTitleElement

public OperationDefinition setTitleElement(StringType value)

Overrides:

setTitleElement in class MetadataResource

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

public String getTitle()

Overrides:

getTitle in class MetadataResource

Returns:

A short, descriptive, user-friendly title for the operation definition.

setTitle

public OperationDefinition setTitle(String value)

Overrides:

setTitle in class MetadataResource

Parameters:

value - A short, descriptive, user-friendly title for the operation definition.

getStatusElement

public Enumeration<Enumerations.PublicationStatus> getStatusElement()

Overrides:

getStatusElement in class MetadataResource

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:

hasStatusElement in class MetadataResource

hasStatus

public boolean hasStatus()

Overrides:

hasStatus in class MetadataResource

setStatusElement

public OperationDefinition setStatusElement(Enumeration<Enumerations.PublicationStatus> value)

Overrides:

setStatusElement in class MetadataResource

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:

getStatus in class MetadataResource

Returns:

The status of this operation definition. Enables tracking the life-cycle of the content.

setStatus

public OperationDefinition setStatus(Enumerations.PublicationStatus value)

Overrides:

setStatus in class MetadataResource

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:

getExperimentalElement in class MetadataResource

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:

hasExperimentalElement in class MetadataResource

hasExperimental

public boolean hasExperimental()

Overrides:

hasExperimental in class MetadataResource

setExperimentalElement

public OperationDefinition setExperimentalElement(BooleanType value)

Overrides:

setExperimentalElement in class MetadataResource

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:

getExperimental in class MetadataResource

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:

setExperimental in class MetadataResource

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:

getDateElement in class MetadataResource

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

public boolean hasDateElement()

Overrides:

hasDateElement in class MetadataResource

hasDate

public boolean hasDate()

Overrides:

hasDate in class MetadataResource

setDateElement

public OperationDefinition setDateElement(DateTimeType value)

Overrides:

setDateElement in class MetadataResource

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

public Date getDate()

Overrides:

getDate in class MetadataResource

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

public OperationDefinition setDate(Date value)

Overrides:

setDate in class MetadataResource

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

public StringType getPublisherElement()

Overrides:

getPublisherElement in class MetadataResource

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

public boolean hasPublisherElement()

Overrides:

hasPublisherElement in class MetadataResource

hasPublisher

public boolean hasPublisher()

Overrides:

hasPublisher in class MetadataResource

setPublisherElement

public OperationDefinition setPublisherElement(StringType value)

Overrides:

setPublisherElement in class MetadataResource

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

public String getPublisher()

Overrides:

getPublisher in class MetadataResource

Returns:

The name of the organization or individual that published the operation definition.

setPublisher

public OperationDefinition setPublisher(String value)

Overrides:

setPublisher in class MetadataResource

Parameters:

value - The name of the organization or individual that published the operation definition.

getContact

public List<ContactDetail> getContact()

Overrides:

getContact in class MetadataResource

Returns:

MetadataResource.contact (Contact details to assist a user in finding and communicating with the publisher.)

setContact

public OperationDefinition setContact(List<ContactDetail> theContact)

Overrides:

setContact in class MetadataResource

Returns:

Returns a reference to this for easy method chaining

hasContact

public boolean hasContact()

Overrides:

hasContact in class MetadataResource

addContact

public ContactDetail addContact()

Overrides:

addContact in class MetadataResource

addContact

public OperationDefinition addContact(ContactDetail t)

Overrides:

addContact in class MetadataResource

getContactFirstRep

public ContactDetail getContactFirstRep()

Overrides:

getContactFirstRep in class MetadataResource

Returns:

The first repetition of repeating field MetadataResource.contact, creating it if it does not already exist

getDescriptionElement

public MarkdownType getDescriptionElement()

Overrides:

getDescriptionElement in class MetadataResource

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:

hasDescriptionElement in class MetadataResource

hasDescription

public boolean hasDescription()

Overrides:

hasDescription in class MetadataResource

setDescriptionElement

public OperationDefinition setDescriptionElement(MarkdownType value)

Overrides:

setDescriptionElement in class MetadataResource

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:

getDescription in class MetadataResource

Returns:

A free text natural language description of the operation definition from a consumer's perspective.

setDescription

public OperationDefinition setDescription(String value)

Overrides:

setDescription in class MetadataResource

Parameters:

value - A free text natural language description of the operation definition from a consumer's perspective.

getUseContext

public List<UsageContext> getUseContext()

Overrides:

getUseContext in class MetadataResource

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

public OperationDefinition setUseContext(List<UsageContext> theUseContext)

Overrides:

setUseContext in class MetadataResource

Returns:

Returns a reference to this for easy method chaining

hasUseContext

public boolean hasUseContext()

Overrides:

hasUseContext in class MetadataResource

addUseContext

public UsageContext addUseContext()

Overrides:

addUseContext in class MetadataResource

addUseContext

public OperationDefinition addUseContext(UsageContext t)

Overrides:

addUseContext in class MetadataResource

getUseContextFirstRep

public UsageContext getUseContextFirstRep()

Overrides:

getUseContextFirstRep in class MetadataResource

Returns:

The first repetition of repeating field MetadataResource.useContext, creating it if it does not already exist

getJurisdiction

public List<CodeableConcept> getJurisdiction()

Overrides:

getJurisdiction in class MetadataResource

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:

setJurisdiction in class MetadataResource

Returns:

Returns a reference to this for easy method chaining

hasJurisdiction

public boolean hasJurisdiction()

Overrides:

hasJurisdiction in class MetadataResource

addJurisdiction

public CodeableConcept addJurisdiction()

Overrides:

addJurisdiction in class MetadataResource

addJurisdiction

public OperationDefinition addJurisdiction(CodeableConcept t)

Overrides:

addJurisdiction in class MetadataResource

getJurisdictionFirstRep

public CodeableConcept getJurisdictionFirstRep()

Overrides:

getJurisdictionFirstRep in class MetadataResource

Returns:

The first repetition of repeating field MetadataResource.jurisdiction, creating it if it does not already exist

getPurposeElement

public MarkdownType 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

public boolean hasPurposeElement()

hasPurpose

public boolean hasPurpose()

setPurposeElement

public OperationDefinition setPurposeElement(MarkdownType value)

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

public String getPurpose()

Returns:

Explanation of why this operation definition is needed and why it has been designed as it has.

setPurpose

public OperationDefinition setPurpose(String value)

Parameters:

value - Explanation of why this operation definition is needed and why it has been designed as it has.

getAffectsStateElement

public BooleanType 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

public boolean hasAffectsStateElement()

hasAffectsState

public boolean hasAffectsState()

setAffectsStateElement

public OperationDefinition setAffectsStateElement(BooleanType value)

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

public boolean getAffectsState()

Returns:

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

setAffectsState

public OperationDefinition setAffectsState(boolean value)

Parameters:

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

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

getCode

public String getCode()

Returns:

The name used to invoke the operation.

setCode

public OperationDefinition setCode(String value)

Parameters:

value - The name used to invoke the operation.

getCommentElement

public MarkdownType 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(MarkdownType 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.

getBaseElement

public CanonicalType 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

public boolean hasBaseElement()

hasBase

public boolean hasBase()

setBaseElement

public OperationDefinition setBaseElement(CanonicalType value)

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

public String getBase()

Returns:

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

setBase

public OperationDefinition setBase(String value)

Parameters:

value - 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 this for 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.

getInputProfileElement

public CanonicalType 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

public boolean hasInputProfileElement()

hasInputProfile

public boolean hasInputProfile()

setInputProfileElement

public OperationDefinition setInputProfileElement(CanonicalType value)

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

public String 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

public OperationDefinition setInputProfile(String value)

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

public CanonicalType 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

public boolean hasOutputProfileElement()

hasOutputProfile

public boolean hasOutputProfile()

setOutputProfileElement

public OperationDefinition setOutputProfileElement(CanonicalType value)

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

public String 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

public OperationDefinition setOutputProfile(String value)

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

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 this for 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 this for 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:

listChildren in class MetadataResource

getNamedProperty

public Property getNamedProperty(int _hash,
 String _name,
 boolean _checkValid)
                          throws org.hl7.fhir.exceptions.FHIRException

Overrides:

getNamedProperty in class DomainResource

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 class MetadataResource

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 class MetadataResource

Throws:

org.hl7.fhir.exceptions.FHIRException

setProperty

public Base setProperty(String name,
 Base value)
                 throws org.hl7.fhir.exceptions.FHIRException

Overrides:

setProperty in class MetadataResource

Throws:

org.hl7.fhir.exceptions.FHIRException

removeChild

public void removeChild(String name,
 Base value)
                 throws org.hl7.fhir.exceptions.FHIRException

Overrides:

removeChild in class MetadataResource

Throws:

org.hl7.fhir.exceptions.FHIRException

makeProperty

public Base makeProperty(int hash,
 String name)
                  throws org.hl7.fhir.exceptions.FHIRException

Overrides:

makeProperty in class MetadataResource

Throws:

org.hl7.fhir.exceptions.FHIRException

getTypesForProperty

public String[] getTypesForProperty(int hash,
 String name)
                             throws org.hl7.fhir.exceptions.FHIRException

Overrides:

getTypesForProperty in class MetadataResource

Throws:

org.hl7.fhir.exceptions.FHIRException

addChild

public Base addChild(String name)
              throws org.hl7.fhir.exceptions.FHIRException

Overrides:

addChild in class MetadataResource

Throws:

org.hl7.fhir.exceptions.FHIRException

fhirType

public String fhirType()

Specified by:

fhirType in interface org.hl7.fhir.instance.model.api.IBase

Overrides:

fhirType in class MetadataResource

copy

public OperationDefinition copy()

Specified by:

copy in class MetadataResource

copyValues

public void copyValues(OperationDefinition dst)

typedCopy

protected OperationDefinition typedCopy()

equalsDeep

public boolean equalsDeep(Base other_)

Overrides:

equalsDeep in class MetadataResource

equalsShallow

public boolean equalsShallow(Base other_)

Overrides:

equalsShallow in class MetadataResource

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface org.hl7.fhir.instance.model.api.IBase

Overrides:

isEmpty in class MetadataResource

getResourceType

public ResourceType getResourceType()

Specified by:

getResourceType in class Resource