Package org.hl7.fhir.r5.model

Class ParameterDefinition

java.lang.Object

org.hl7.fhir.r5.model.Base

org.hl7.fhir.r5.model.Element

org.hl7.fhir.r5.model.DataType

org.hl7.fhir.r5.model.ParameterDefinition

All Implemented Interfaces:

ca.uhn.fhir.model.api.IElement, Serializable, org.hl7.fhir.instance.model.api.IBase, org.hl7.fhir.instance.model.api.IBaseDatatype, org.hl7.fhir.instance.model.api.IBaseElement, org.hl7.fhir.instance.model.api.IBaseHasExtensions, org.hl7.fhir.instance.model.api.ICompositeType

public class ParameterDefinition
extends DataType
implements org.hl7.fhir.instance.model.api.ICompositeType

ParameterDefinition Type: The parameters to the module. This collection specifies both the input and output parameters. Input parameters are provided by the caller as part of the $evaluate operation. Output parameters are included in the GuidanceResponse.

See Also:

• Serialized Form

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

Fields

Modifier and Type	Field	Description
protected StringType	documentation	A brief discussion of what the parameter is for and how it is used by the module.
protected StringType	max	The maximum number of times this element is permitted to appear in the request or response.
protected IntegerType	min	The minimum number of times this parameter SHALL appear in the request or response.
protected CodeType	name	The name of the parameter used to allow access to the value of the parameter in evaluation contexts.
protected CanonicalType	profile	If specified, this indicates a profile that the input data must conform to, or that the output data will conform to.
protected Enumeration<Enumerations.FHIRTypes>	type	The type of the parameter.
protected Enumeration<Enumerations.OperationParameterUse>	use	Whether the parameter is input or output for the module.

Fields inherited from class org.hl7.fhir.r5.model.Element

extension, id

Constructor Summary

Constructors

Constructor	Description
ParameterDefinition()	Constructor
ParameterDefinition(Enumerations.OperationParameterUse use, Enumerations.FHIRTypes type)	Constructor

Method Summary

Modifier and Type	Method	Description
Base	addChild(String name)
ParameterDefinition	copy()
void	copyValues(ParameterDefinition dst)
boolean	equalsDeep(Base other_)
boolean	equalsShallow(Base other_)
String	fhirType()
String	getDocumentation()
StringType	getDocumentationElement()
String	getMax()
StringType	getMaxElement()
int	getMin()
IntegerType	getMinElement()
String	getName()
Property	getNamedProperty(int _hash, String _name, boolean _checkValid)
CodeType	getNameElement()
String	getProfile()
CanonicalType	getProfileElement()
Base[]	getProperty(int hash, String name, boolean checkValid)
Enumerations.FHIRTypes	getType()
Enumeration<Enumerations.FHIRTypes>	getTypeElement()
String[]	getTypesForProperty(int hash, String name)
Enumerations.OperationParameterUse	getUse()
Enumeration<Enumerations.OperationParameterUse>	getUseElement()
boolean	hasDocumentation()
boolean	hasDocumentationElement()
boolean	hasMax()
boolean	hasMaxElement()
boolean	hasMin()
boolean	hasMinElement()
boolean	hasName()
boolean	hasNameElement()
boolean	hasProfile()
boolean	hasProfileElement()
boolean	hasType()
boolean	hasTypeElement()
boolean	hasUse()
boolean	hasUseElement()
boolean	isEmpty()
protected void	listChildren(List<Property> children)
Base	makeProperty(int hash, String name)
void	removeChild(String name, Base value)
ParameterDefinition	setDocumentation(String value)
ParameterDefinition	setDocumentationElement(StringType value)
ParameterDefinition	setMax(String value)
ParameterDefinition	setMaxElement(StringType value)
ParameterDefinition	setMin(int value)
ParameterDefinition	setMinElement(IntegerType value)
ParameterDefinition	setName(String value)
ParameterDefinition	setNameElement(CodeType value)
ParameterDefinition	setProfile(String value)
ParameterDefinition	setProfileElement(CanonicalType value)
Base	setProperty(int hash, String name, Base value)
Base	setProperty(String name, Base value)
ParameterDefinition	setType(Enumerations.FHIRTypes value)
ParameterDefinition	setTypeElement(Enumeration<Enumerations.FHIRTypes> value)
ParameterDefinition	setUse(Enumerations.OperationParameterUse value)
ParameterDefinition	setUseElement(Enumeration<Enumerations.OperationParameterUse> value)
protected ParameterDefinition	typedCopy()

Methods inherited from class org.hl7.fhir.r5.model.DataType

copyValues, getTranslation, isTranslatable

Methods inherited from class org.hl7.fhir.r5.model.Element

addExtension, addExtension, addExtension, copyExtensions, copyNewExtensions, copyValues, getExtension, getExtensionByUrl, getExtensionFirstRep, getExtensionsByUrl, getExtensionsByUrl, getExtensionString, getExtensionString, getFHIRPublicationVersion, getId, getIdBase, getIdElement, getStandardsStatus, hasExtension, hasExtension, hasExtension, hasExtension, hasId, hasIdElement, isDisallowExtensions, noExtensions, removeExtension, 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

Field Details

name

protected CodeType name

The name of the parameter used to allow access to the value of the parameter in evaluation contexts.

use

protected Enumeration<Enumerations.OperationParameterUse> use

Whether the parameter is input or output for the module.

min

protected IntegerType min

The minimum number of times this parameter SHALL appear in the request or response.

max

protected StringType max

The maximum number of times this element is permitted to appear in the request or response.

documentation

protected StringType documentation

A brief discussion of what the parameter is for and how it is used by the module.

type

protected Enumeration<Enumerations.FHIRTypes> type

The type of the parameter.

profile

protected CanonicalType profile

If specified, this indicates a profile that the input data must conform to, or that the output data will conform to.

Constructor Details

ParameterDefinition

public ParameterDefinition()

Constructor

ParameterDefinition

public ParameterDefinition(Enumerations.OperationParameterUse use,
 Enumerations.FHIRTypes type)

Constructor

Method Details

getNameElement

public CodeType getNameElement()

Returns:

name (The name of the parameter used to allow access to the value of the parameter in evaluation contexts.). This is the underlying object with id, value and extensions. The accessor "getName" gives direct access to the value

hasNameElement

public boolean hasNameElement()

hasName

public boolean hasName()

setNameElement

public ParameterDefinition setNameElement(CodeType value)

Parameters:

value - name (The name of the parameter used to allow access to the value of the parameter in evaluation contexts.). This is the underlying object with id, value and extensions. The accessor "getName" gives direct access to the value

getName

public String getName()

Returns:

The name of the parameter used to allow access to the value of the parameter in evaluation contexts.

setName

public ParameterDefinition setName(String value)

Parameters:

value - The name of the parameter used to allow access to the value of the parameter in evaluation contexts.

getUseElement

public Enumeration<Enumerations.OperationParameterUse> getUseElement()

Returns:

use (Whether the parameter is input or output for the module.). This is the underlying object with id, value and extensions. The accessor "getUse" gives direct access to the value

hasUseElement

public boolean hasUseElement()

hasUse

public boolean hasUse()

setUseElement

public ParameterDefinition setUseElement(Enumeration<Enumerations.OperationParameterUse> value)

Parameters:

value - use (Whether the parameter is input or output for the module.). This is the underlying object with id, value and extensions. The accessor "getUse" gives direct access to the value

getUse

public Enumerations.OperationParameterUse getUse()

Returns:

Whether the parameter is input or output for the module.

setUse

public ParameterDefinition setUse(Enumerations.OperationParameterUse value)

Parameters:

value - Whether the parameter is input or output for the module.

getMinElement

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

public boolean hasMinElement()

hasMin

public boolean hasMin()

setMinElement

public ParameterDefinition setMinElement(IntegerType value)

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

public int getMin()

Returns:

The minimum number of times this parameter SHALL appear in the request or response.

setMin

public ParameterDefinition setMin(int value)

Parameters:

value - The minimum number of times this parameter SHALL appear in the request or response.

getMaxElement

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

public boolean hasMaxElement()

hasMax

public boolean hasMax()

setMaxElement

public ParameterDefinition setMaxElement(StringType value)

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

public String getMax()

Returns:

The maximum number of times this element is permitted to appear in the request or response.

setMax

public ParameterDefinition setMax(String value)

Parameters:

value - The maximum number of times this element is permitted to appear in the request or response.

getDocumentationElement

public StringType getDocumentationElement()

Returns:

documentation (A brief discussion of what the parameter is for and how it is used by the module.). This is the underlying object with id, value and extensions. The accessor "getDocumentation" gives direct access to the value

hasDocumentationElement

public boolean hasDocumentationElement()

hasDocumentation

public boolean hasDocumentation()

setDocumentationElement

public ParameterDefinition setDocumentationElement(StringType value)

Parameters:

value - documentation (A brief discussion of what the parameter is for and how it is used by the module.). This is the underlying object with id, value and extensions. The accessor "getDocumentation" gives direct access to the value

getDocumentation

public String getDocumentation()

Returns:

A brief discussion of what the parameter is for and how it is used by the module.

setDocumentation

public ParameterDefinition setDocumentation(String value)

Parameters:

value - A brief discussion of what the parameter is for and how it is used by the module.

getTypeElement

public Enumeration<Enumerations.FHIRTypes> getTypeElement()

Returns:

type (The type of the parameter.). 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 ParameterDefinition setTypeElement(Enumeration<Enumerations.FHIRTypes> value)

Parameters:

value - type (The type of the parameter.). This is the underlying object with id, value and extensions. The accessor "getType" gives direct access to the value

getType

public Enumerations.FHIRTypes getType()

Returns:

The type of the parameter.

setType

public ParameterDefinition setType(Enumerations.FHIRTypes value)

Parameters:

value - The type of the parameter.

getProfileElement

public CanonicalType getProfileElement()

Returns:

profile (If specified, this indicates a profile that the input data must conform to, or that the output data will conform to.). This is the underlying object with id, value and extensions. The accessor "getProfile" gives direct access to the value

hasProfileElement

public boolean hasProfileElement()

hasProfile

public boolean hasProfile()

setProfileElement

public ParameterDefinition setProfileElement(CanonicalType value)

Parameters:

value - profile (If specified, this indicates a profile that the input data must conform to, or that the output data will conform to.). This is the underlying object with id, value and extensions. The accessor "getProfile" gives direct access to the value

getProfile

public String getProfile()

Returns:

If specified, this indicates a profile that the input data must conform to, or that the output data will conform to.

setProfile

public ParameterDefinition setProfile(String value)

Parameters:

value - If specified, this indicates a profile that the input data must conform to, or that the output data will conform to.

listChildren

protected void listChildren(List<Property> children)

Overrides:

listChildren in class Element

getNamedProperty

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

Overrides:

getNamedProperty in class Element

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 Element

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 Element

Throws:

org.hl7.fhir.exceptions.FHIRException

setProperty

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

Overrides:

setProperty in class Element

Throws:

org.hl7.fhir.exceptions.FHIRException

removeChild

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

Overrides:

removeChild in class Element

Throws:

org.hl7.fhir.exceptions.FHIRException

makeProperty

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

Overrides:

makeProperty in class Element

Throws:

org.hl7.fhir.exceptions.FHIRException

getTypesForProperty

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

Overrides:

getTypesForProperty in class Element

Throws:

org.hl7.fhir.exceptions.FHIRException

addChild

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

Overrides:

addChild in class Element

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 DataType

Returns:

the FHIR type name of the instance (not the java class name)

copy

public ParameterDefinition copy()

Specified by:

copy in class DataType

copyValues

public void copyValues(ParameterDefinition dst)

typedCopy

protected ParameterDefinition typedCopy()

equalsDeep

public boolean equalsDeep(Base other_)

Overrides:

equalsDeep in class Element

equalsShallow

public boolean equalsShallow(Base other_)

Overrides:

equalsShallow in class Element

isEmpty

public boolean isEmpty()

Specified by:

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

Overrides:

isEmpty in class Element