Package org.hl7.fhir.r5.model
Class OperationDefinition.OperationDefinitionParameterComponent
java.lang.Object
org.hl7.fhir.r5.model.Base
org.hl7.fhir.r5.model.Element
org.hl7.fhir.r5.model.BackboneElement
org.hl7.fhir.r5.model.OperationDefinition.OperationDefinitionParameterComponent
- All Implemented Interfaces:
ca.uhn.fhir.model.api.IElement
,Serializable
,org.hl7.fhir.instance.model.api.IBase
,org.hl7.fhir.instance.model.api.IBaseBackboneElement
,org.hl7.fhir.instance.model.api.IBaseElement
,org.hl7.fhir.instance.model.api.IBaseHasExtensions
,org.hl7.fhir.instance.model.api.IBaseHasModifierExtensions
- Enclosing class:
OperationDefinition
public static class OperationDefinition.OperationDefinitionParameterComponent
extends BackboneElement
implements org.hl7.fhir.instance.model.api.IBaseBackboneElement
- See Also:
-
Nested Class Summary
Nested classes/interfaces inherited from class org.hl7.fhir.r5.model.Base
Base.ProfileSource, Base.ValidationInfo, Base.ValidationMode, Base.ValidationReason
-
Field Summary
Modifier and TypeFieldDescriptionprotected List
<Enumeration<Enumerations.FHIRTypes>> Support for polymorphic types.Binds to a value set if this parameter is coded (code, Coding, CodeableConcept).protected MarkdownType
Describes the meaning or use of this parameter.protected StringType
The maximum number of times this element is permitted to appear in the request or response.protected IntegerType
The minimum number of times this parameter SHALL appear in the request or response.protected CodeType
The name of used to identify the parameter.The parts of a nested Parameter.Identifies other resource parameters within the operation invocation that are expected to resolve to this resource.If present, indicates that the parameter applies when the operation is being invoked at the specified level.protected Enumeration
<Enumerations.SearchParamType> How the parameter is understood if/when it used as search parameter.protected List
<CanonicalType> Used when the type is "Reference" or "canonical", and identifies a profile structure or implementation Guide that applies to the target of the reference this parameter refers to.protected Enumeration
<Enumerations.FHIRTypes> The type for this parameter.protected Enumeration
<Enumerations.OperationParameterUse> Whether this is an input or an output parameter.Fields inherited from class org.hl7.fhir.r5.model.BackboneElement
modifierExtension
-
Constructor Summary
ConstructorDescriptionConstructorOperationDefinitionParameterComponent
(String name, Enumerations.OperationParameterUse use, int min, String max) Constructor -
Method Summary
Modifier and TypeMethodDescriptionaddPart()
addTargetProfile
(String value) copy()
void
boolean
equalsDeep
(Base other_) boolean
equalsShallow
(Base other_) fhirType()
getMax()
int
getMin()
getName()
getNamedProperty
(int _hash, String _name, boolean _checkValid) getPart()
Base[]
getProperty
(int hash, String name, boolean checkValid) getScope()
getType()
String[]
getTypesForProperty
(int hash, String name) getUse()
boolean
boolean
boolean
boolean
boolean
boolean
hasMax()
boolean
boolean
hasMin()
boolean
boolean
hasName()
boolean
boolean
hasPart()
boolean
boolean
hasScope()
boolean
boolean
boolean
boolean
boolean
hasTargetProfile
(String value) boolean
hasType()
boolean
boolean
hasUse()
boolean
boolean
isEmpty()
protected void
listChildren
(List<Property> children) makeProperty
(int hash, String name) void
removeChild
(String name, Base value) setAllowedType
(List<Enumeration<Enumerations.FHIRTypes>> theAllowedType) setDocumentation
(String value) setMaxElement
(StringType value) setMin
(int value) setMinElement
(IntegerType value) setNameElement
(CodeType value) setProperty
(int hash, String name, Base value) setProperty
(String name, Base value) setReferencedFrom
(List<OperationDefinition.OperationDefinitionParameterReferencedFromComponent> theReferencedFrom) setTargetProfile
(List<CanonicalType> theTargetProfile) setType
(Enumerations.FHIRTypes value) Methods inherited from class org.hl7.fhir.r5.model.BackboneElement
addModifierExtension, addModifierExtension, addModifierExtension, checkNoModifiers, copyExtensions, copyNewExtensions, copyValues, getExtensionByUrl, getExtensionsByUrl, getExtensionsByUrl, getModifierExtension, getModifierExtensionFirstRep, hasExtension, hasExtension, hasModifierExtension, removeExtension, setModifierExtension
Methods inherited from class org.hl7.fhir.r5.model.Element
addExtension, addExtension, addExtension, copyExtensions, copyNewExtensions, copyValues, getExtension, getExtensionFirstRep, getExtensionString, getExtensionString, getFHIRPublicationVersion, getId, getIdBase, getIdElement, getStandardsStatus, hasExtension, hasExtension, hasId, hasIdElement, isDisallowExtensions, noExtensions, setDisallowExtensions, setExtension, setId, setIdBase, setIdElement, setStandardsStatus
Methods inherited from class org.hl7.fhir.r5.model.Base
addDefinition, addFormatCommentsPost, addFormatCommentsPre, addValidationMessage, canHavePrimitiveValue, children, clearUserData, compareDeep, compareDeep, compareDeep, compareDeep, compareValues, compareValues, copyFormatComments, copyUserData, copyValues, dateTimeValue, equals, getChildByName, getChildValueByName, getFormatCommentsPost, getFormatCommentsPre, getNamedProperty, getUserData, getUserInt, getUserString, getValidationInfo, getValidationMessages, getXhtml, hasFormatComment, hasFormatCommentPost, hasFormatCommentPre, hasPrimitiveValue, hasType, hasUserData, hasValidated, hasValidationInfo, hasValidationMessages, isBooleanPrimitive, isCopyUserData, isDateTime, isMetadataBased, isPrimitive, isResource, listChildrenByName, listChildrenByName, primitiveValue, setCopyUserData, setUserData, setUserDataINN
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Methods inherited from interface org.hl7.fhir.instance.model.api.IBase
getFormatCommentsPost, getFormatCommentsPre, getUserData, hasFormatComment, setUserData
Methods inherited from interface org.hl7.fhir.instance.model.api.IBaseElement
getUserData, setUserData
Methods inherited from interface org.hl7.fhir.instance.model.api.IBaseHasExtensions
addExtension, getExtension, hasExtension
Methods inherited from interface org.hl7.fhir.instance.model.api.IBaseHasModifierExtensions
addModifierExtension, getModifierExtension, hasModifierExtension
-
Field Details
-
name
The name of used to identify the parameter. -
use
Whether this is an input or an output parameter. -
scope
If present, indicates that the parameter applies when the operation is being invoked at the specified level. -
min
The minimum number of times this parameter SHALL appear in the request or response. -
max
The maximum number of times this element is permitted to appear in the request or response. -
documentation
Describes the meaning or use of this parameter. -
type
The type for this parameter. -
allowedType
Support for polymorphic types. If the parameter type is abstract, this element lists allowed sub-types for the parameter. -
targetProfile
Used when the type is "Reference" or "canonical", and identifies a profile structure or implementation Guide that applies to the target of the reference this parameter refers to. If any profiles are specified, then the content must conform to at least one of them. The URL can be a local reference - to a contained StructureDefinition, or a reference to another StructureDefinition or Implementation Guide by a canonical URL. When an implementation guide is specified, the target resource SHALL conform to at least one profile defined in the implementation guide. -
searchType
How the parameter is understood if/when it used as search parameter. This is only used if the parameter is a string. -
binding
Binds to a value set if this parameter is coded (code, Coding, CodeableConcept). -
referencedFrom
protected List<OperationDefinition.OperationDefinitionParameterReferencedFromComponent> referencedFromIdentifies other resource parameters within the operation invocation that are expected to resolve to this resource. -
part
The parts of a nested Parameter.
-
-
Constructor Details
-
OperationDefinitionParameterComponent
Constructor -
OperationDefinitionParameterComponent
public OperationDefinitionParameterComponent(String name, Enumerations.OperationParameterUse use, int min, String max) Constructor
-
-
Method Details
-
getNameElement
- Returns:
name
(The name of used to identify the parameter.). This is the underlying object with id, value and extensions. The accessor "getName" gives direct access to the value
-
hasNameElement
-
hasName
-
setNameElement
- Parameters:
value
-name
(The name of used to identify the parameter.). This is the underlying object with id, value and extensions. The accessor "getName" gives direct access to the value
-
getName
- Returns:
- The name of used to identify the parameter.
-
setName
- Parameters:
value
- The name of used to identify the parameter.
-
getUseElement
- Returns:
use
(Whether this is an input or an output parameter.). This is the underlying object with id, value and extensions. The accessor "getUse" gives direct access to the value
-
hasUseElement
-
hasUse
-
setUseElement
public OperationDefinition.OperationDefinitionParameterComponent setUseElement(Enumeration<Enumerations.OperationParameterUse> value) - Parameters:
value
-use
(Whether this is an input or an output parameter.). This is the underlying object with id, value and extensions. The accessor "getUse" gives direct access to the value
-
getUse
- Returns:
- Whether this is an input or an output parameter.
-
setUse
public OperationDefinition.OperationDefinitionParameterComponent setUse(Enumerations.OperationParameterUse value) - Parameters:
value
- Whether this is an input or an output parameter.
-
getScope
- Returns:
scope
(If present, indicates that the parameter applies when the operation is being invoked at the specified level.)
-
setScope
public OperationDefinition.OperationDefinitionParameterComponent setScope(List<Enumeration<OperationDefinition.OperationParameterScope>> theScope) - Returns:
- Returns a reference to
this
for easy method chaining
-
hasScope
-
addScopeElement
- Returns:
scope
(If present, indicates that the parameter applies when the operation is being invoked at the specified level.)
-
addScope
public OperationDefinition.OperationDefinitionParameterComponent addScope(OperationDefinition.OperationParameterScope value) - Parameters:
value
-scope
(If present, indicates that the parameter applies when the operation is being invoked at the specified level.)
-
hasScope
- Parameters:
value
-scope
(If present, indicates that the parameter applies when the operation is being invoked at the specified level.)
-
getMinElement
- Returns:
min
(The minimum number of times this parameter SHALL appear in the request or response.). This is the underlying object with id, value and extensions. The accessor "getMin" gives direct access to the value
-
hasMinElement
-
hasMin
-
setMinElement
- Parameters:
value
-min
(The minimum number of times this parameter SHALL appear in the request or response.). This is the underlying object with id, value and extensions. The accessor "getMin" gives direct access to the value
-
getMin
- Returns:
- The minimum number of times this parameter SHALL appear in the request or response.
-
setMin
- Parameters:
value
- The minimum number of times this parameter SHALL appear in the request or response.
-
getMaxElement
- Returns:
max
(The maximum number of times this element is permitted to appear in the request or response.). This is the underlying object with id, value and extensions. The accessor "getMax" gives direct access to the value
-
hasMaxElement
-
hasMax
-
setMaxElement
- Parameters:
value
-max
(The maximum number of times this element is permitted to appear in the request or response.). This is the underlying object with id, value and extensions. The accessor "getMax" gives direct access to the value
-
getMax
- Returns:
- The maximum number of times this element is permitted to appear in the request or response.
-
setMax
- Parameters:
value
- The maximum number of times this element is permitted to appear in the request or response.
-
getDocumentationElement
- Returns:
documentation
(Describes the meaning or use of this parameter.). This is the underlying object with id, value and extensions. The accessor "getDocumentation" gives direct access to the value
-
hasDocumentationElement
-
hasDocumentation
-
setDocumentationElement
public OperationDefinition.OperationDefinitionParameterComponent setDocumentationElement(MarkdownType value) - Parameters:
value
-documentation
(Describes the meaning or use of this parameter.). This is the underlying object with id, value and extensions. The accessor "getDocumentation" gives direct access to the value
-
getDocumentation
- Returns:
- Describes the meaning or use of this parameter.
-
setDocumentation
- Parameters:
value
- Describes the meaning or use of this parameter.
-
getTypeElement
- Returns:
type
(The type for this parameter.). This is the underlying object with id, value and extensions. The accessor "getType" gives direct access to the value
-
hasTypeElement
-
hasType
-
setTypeElement
public OperationDefinition.OperationDefinitionParameterComponent setTypeElement(Enumeration<Enumerations.FHIRTypes> value) - Parameters:
value
-type
(The type for this parameter.). This is the underlying object with id, value and extensions. The accessor "getType" gives direct access to the value
-
getType
- Returns:
- The type for this parameter.
-
setType
public OperationDefinition.OperationDefinitionParameterComponent setType(Enumerations.FHIRTypes value) - Parameters:
value
- The type for this parameter.
-
getAllowedType
- Returns:
allowedType
(Support for polymorphic types. If the parameter type is abstract, this element lists allowed sub-types for the parameter.)
-
setAllowedType
public OperationDefinition.OperationDefinitionParameterComponent setAllowedType(List<Enumeration<Enumerations.FHIRTypes>> theAllowedType) - Returns:
- Returns a reference to
this
for easy method chaining
-
hasAllowedType
-
addAllowedTypeElement
- Returns:
allowedType
(Support for polymorphic types. If the parameter type is abstract, this element lists allowed sub-types for the parameter.)
-
addAllowedType
public OperationDefinition.OperationDefinitionParameterComponent addAllowedType(Enumerations.FHIRTypes value) - Parameters:
value
-allowedType
(Support for polymorphic types. If the parameter type is abstract, this element lists allowed sub-types for the parameter.)
-
hasAllowedType
- Parameters:
value
-allowedType
(Support for polymorphic types. If the parameter type is abstract, this element lists allowed sub-types for the parameter.)
-
getTargetProfile
- Returns:
targetProfile
(Used when the type is "Reference" or "canonical", and identifies a profile structure or implementation Guide that applies to the target of the reference this parameter refers to. If any profiles are specified, then the content must conform to at least one of them. The URL can be a local reference - to a contained StructureDefinition, or a reference to another StructureDefinition or Implementation Guide by a canonical URL. When an implementation guide is specified, the target resource SHALL conform to at least one profile defined in the implementation guide.)
-
setTargetProfile
public OperationDefinition.OperationDefinitionParameterComponent setTargetProfile(List<CanonicalType> theTargetProfile) - Returns:
- Returns a reference to
this
for easy method chaining
-
hasTargetProfile
-
addTargetProfileElement
- Returns:
targetProfile
(Used when the type is "Reference" or "canonical", and identifies a profile structure or implementation Guide that applies to the target of the reference this parameter refers to. If any profiles are specified, then the content must conform to at least one of them. The URL can be a local reference - to a contained StructureDefinition, or a reference to another StructureDefinition or Implementation Guide by a canonical URL. When an implementation guide is specified, the target resource SHALL conform to at least one profile defined in the implementation guide.)
-
addTargetProfile
- Parameters:
value
-targetProfile
(Used when the type is "Reference" or "canonical", and identifies a profile structure or implementation Guide that applies to the target of the reference this parameter refers to. If any profiles are specified, then the content must conform to at least one of them. The URL can be a local reference - to a contained StructureDefinition, or a reference to another StructureDefinition or Implementation Guide by a canonical URL. When an implementation guide is specified, the target resource SHALL conform to at least one profile defined in the implementation guide.)
-
hasTargetProfile
- Parameters:
value
-targetProfile
(Used when the type is "Reference" or "canonical", and identifies a profile structure or implementation Guide that applies to the target of the reference this parameter refers to. If any profiles are specified, then the content must conform to at least one of them. The URL can be a local reference - to a contained StructureDefinition, or a reference to another StructureDefinition or Implementation Guide by a canonical URL. When an implementation guide is specified, the target resource SHALL conform to at least one profile defined in the implementation guide.)
-
getSearchTypeElement
- Returns:
searchType
(How the parameter is understood if/when it used as search parameter. This is only used if the parameter is a string.). This is the underlying object with id, value and extensions. The accessor "getSearchType" gives direct access to the value
-
hasSearchTypeElement
-
hasSearchType
-
setSearchTypeElement
public OperationDefinition.OperationDefinitionParameterComponent setSearchTypeElement(Enumeration<Enumerations.SearchParamType> value) - Parameters:
value
-searchType
(How the parameter is understood if/when it used as search parameter. This is only used if the parameter is a string.). This is the underlying object with id, value and extensions. The accessor "getSearchType" gives direct access to the value
-
getSearchType
- Returns:
- How the parameter is understood if/when it used as search parameter. This is only used if the parameter is a string.
-
setSearchType
public OperationDefinition.OperationDefinitionParameterComponent setSearchType(Enumerations.SearchParamType value) - Parameters:
value
- How the parameter is understood if/when it used as search parameter. This is only used if the parameter is a string.
-
getBinding
- Returns:
binding
(Binds to a value set if this parameter is coded (code, Coding, CodeableConcept).)
-
hasBinding
-
setBinding
public OperationDefinition.OperationDefinitionParameterComponent setBinding(OperationDefinition.OperationDefinitionParameterBindingComponent value) - Parameters:
value
-binding
(Binds to a value set if this parameter is coded (code, Coding, CodeableConcept).)
-
getReferencedFrom
public List<OperationDefinition.OperationDefinitionParameterReferencedFromComponent> getReferencedFrom()- Returns:
referencedFrom
(Identifies other resource parameters within the operation invocation that are expected to resolve to this resource.)
-
setReferencedFrom
public OperationDefinition.OperationDefinitionParameterComponent setReferencedFrom(List<OperationDefinition.OperationDefinitionParameterReferencedFromComponent> theReferencedFrom) - Returns:
- Returns a reference to
this
for easy method chaining
-
hasReferencedFrom
-
addReferencedFrom
-
addReferencedFrom
-
getReferencedFromFirstRep
public OperationDefinition.OperationDefinitionParameterReferencedFromComponent getReferencedFromFirstRep()- Returns:
- The first repetition of repeating field
referencedFrom
, creating it if it does not already exist {3}
-
getPart
- Returns:
part
(The parts of a nested Parameter.)
-
setPart
public OperationDefinition.OperationDefinitionParameterComponent setPart(List<OperationDefinition.OperationDefinitionParameterComponent> thePart) - Returns:
- Returns a reference to
this
for easy method chaining
-
hasPart
-
addPart
-
addPart
-
getPartFirstRep
- Returns:
- The first repetition of repeating field
part
, creating it if it does not already exist {3}
-
listChildren
- Overrides:
listChildren
in classBackboneElement
-
getNamedProperty
public Property getNamedProperty(int _hash, String _name, boolean _checkValid) throws org.hl7.fhir.exceptions.FHIRException - Overrides:
getNamedProperty
in classBackboneElement
- 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 classBackboneElement
- 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 classBackboneElement
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
setProperty
- Overrides:
setProperty
in classBackboneElement
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
removeChild
- Overrides:
removeChild
in classBackboneElement
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
makeProperty
- Overrides:
makeProperty
in classBackboneElement
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
getTypesForProperty
public String[] getTypesForProperty(int hash, String name) throws org.hl7.fhir.exceptions.FHIRException - Overrides:
getTypesForProperty
in classBackboneElement
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
addChild
- Overrides:
addChild
in classBackboneElement
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
copy
- Specified by:
copy
in classBackboneElement
-
copyValues
-
equalsDeep
- Overrides:
equalsDeep
in classBackboneElement
-
equalsShallow
- Overrides:
equalsShallow
in classBackboneElement
-
isEmpty
- Specified by:
isEmpty
in interfaceorg.hl7.fhir.instance.model.api.IBase
- Overrides:
isEmpty
in classBackboneElement
-
fhirType
- Specified by:
fhirType
in interfaceorg.hl7.fhir.instance.model.api.IBase
- Overrides:
fhirType
in classBackboneElement
- Returns:
- the FHIR type name of the instance (not the java class name)
-