ParameterDefinition (HAPI FHIR Structures

java.lang.Object
- org.hl7.fhir.dstu3.model.Base
- - org.hl7.fhir.dstu3.model.Element
  - - org.hl7.fhir.dstu3.model.Type
    - - org.hl7.fhir.dstu3.model.ParameterDefinition

All Implemented Interfaces:

IElement, Serializable, IBase, IBaseDatatype, IBaseElement, IBaseHasExtensions, ICompositeType
```
public class ParameterDefinition
extends Type
implements ICompositeType
```
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
Modifier and Type Class and Description

static class ParameterDefinition.ParameterUse

static class ParameterDefinition.ParameterUseEnumFactory

Nested Classes
Modifier and Type	Class and Description
`static class`	`ParameterDefinition.ParameterUse`
`static class`	`ParameterDefinition.ParameterUseEnumFactory`

Field Summary

Fields
Modifier and Type	Field and 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 Reference`	`profile` If specified, this indicates a profile that the input data must conform to, or that the output data will conform to.
`protected StructureDefinition`	`profileTarget` The actual object that is the target of the reference (If specified, this indicates a profile that the input data must conform to, or that the output data will conform to.)
`protected CodeType`	`type` The type of the parameter.
`protected Enumeration<ParameterDefinition.ParameterUse>`	`use` Whether the parameter is input or output for the module.

Fields inherited from class org.hl7.fhir.dstu3.model.Element
extension, id

Constructor Summary

Constructors
Constructor and Description
`ParameterDefinition()` Constructor
`ParameterDefinition(Enumeration<ParameterDefinition.ParameterUse> use, CodeType type)` Constructor

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Base`	`addChild(String name)`
`ParameterDefinition`	`copy()`
`boolean`	`equalsDeep(Base other)`
`boolean`	`equalsShallow(Base other)`
`String`	`fhirType()`
`String`	`getDocumentation()`
`StringType`	`getDocumentationElement()`
`String`	`getMax()`
`StringType`	`getMaxElement()`
`int`	`getMin()`
`IntegerType`	`getMinElement()`
`String`	`getName()`
`CodeType`	`getNameElement()`
`Reference`	`getProfile()`
`StructureDefinition`	`getProfileTarget()`
`Base[]`	`getProperty(int hash, String name, boolean checkValid)`
`String`	`getType()`
`CodeType`	`getTypeElement()`
`String[]`	`getTypesForProperty(int hash, String name)`
`ParameterDefinition.ParameterUse`	`getUse()`
`Enumeration<ParameterDefinition.ParameterUse>`	`getUseElement()`
`boolean`	`hasDocumentation()`
`boolean`	`hasDocumentationElement()`
`boolean`	`hasMax()`
`boolean`	`hasMaxElement()`
`boolean`	`hasMin()`
`boolean`	`hasMinElement()`
`boolean`	`hasName()`
`boolean`	`hasNameElement()`
`boolean`	`hasProfile()`
`boolean`	`hasType()`
`boolean`	`hasTypeElement()`
`boolean`	`hasUse()`
`boolean`	`hasUseElement()`
`boolean`	`isEmpty()`
`protected void`	`listChildren(List<Property> childrenList)`
`Base`	`makeProperty(int hash, String name)`
`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(Reference value)`
`ParameterDefinition`	`setProfileTarget(StructureDefinition value)`
`Base`	`setProperty(int hash, String name, Base value)`
`Base`	`setProperty(String name, Base value)`
`ParameterDefinition`	`setType(String value)`
`ParameterDefinition`	`setTypeElement(CodeType value)`
`ParameterDefinition`	`setUse(ParameterDefinition.ParameterUse value)`
`ParameterDefinition`	`setUseElement(Enumeration<ParameterDefinition.ParameterUse> value)`
`protected ParameterDefinition`	`typedCopy()`

Methods inherited from class org.hl7.fhir.dstu3.model.Element
addExtension, addExtension, addExtension, copyValues, getExtension, getExtensionFirstRep, getExtensionsByUrl, getExtensionString, getId, getIdBase, getIdElement, hasExtension, hasExtension, hasId, hasIdElement, setExtension, setId, setIdBase, setIdElement

Methods inherited from class org.hl7.fhir.dstu3.model.Base
castToAddress, castToAnnotation, castToAttachment, castToBase64Binary, castToBoolean, castToCode, castToCodeableConcept, castToCoding, castToContactDetail, castToContactPoint, castToContributor, castToDataRequirement, castToDate, castToDateTime, castToDecimal, castToDosage, castToDuration, castToElementDefinition, castToExtension, castToHumanName, castToId, castToIdentifier, castToInstant, castToInteger, castToMarkdown, castToMeta, castToMoney, castToNarrative, castToOid, castToParameterDefinition, castToPeriod, castToPositiveInt, castToQuantity, castToRange, castToRatio, castToReference, castToRelatedArtifact, castToResource, castToSampledData, castToSignature, castToSimpleQuantity, castToString, castToTime, castToTiming, castToTriggerDefinition, castToType, castToUnsignedInt, castToUri, castToUsageContext, castToXhtml, castToXhtmlString, children, clearUserData, compareDeep, compareDeep, compareDeep, compareValues, compareValues, equals, getChildByName, getFormatCommentsPost, getFormatCommentsPre, getUserData, getUserInt, getUserString, hasFormatComment, hasPrimitiveValue, hasType, hasUserData, isMetadataBased, isPrimitive, isResource, listChildrenByName, listChildrenByName, primitiveValue, 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, hasFormatComment

- Field Detail
  - 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<ParameterDefinition.ParameterUse> 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 CodeType type
```
    The type of the parameter.
  - profile
```
protected Reference profile
```
    If specified, this indicates a profile that the input data must conform to, or that the output data will conform to.
  - profileTarget
```
protected StructureDefinition profileTarget
```
    The actual object that is the target of the reference (If specified, this indicates a profile that the input data must conform to, or that the output data will conform to.)
- Constructor Detail
  - ParameterDefinition
```
public ParameterDefinition()
```
    Constructor
  - ParameterDefinition
```
public ParameterDefinition(Enumeration<ParameterDefinition.ParameterUse> use,
                           CodeType type)
```
    Constructor
- Method Detail
  - 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<ParameterDefinition.ParameterUse> 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<ParameterDefinition.ParameterUse> 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 ParameterDefinition.ParameterUse getUse()
```
    Returns:
    
    Whether the parameter is input or output for the module.
  - setUse
```
public ParameterDefinition setUse(ParameterDefinition.ParameterUse 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 CodeType 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(CodeType 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 String getType()
```
    Returns:
    
    The type of the parameter.
  - setType
```
public ParameterDefinition setType(String value)
```
    Parameters:
    
    value - The type of the parameter.
  - getProfile
```
public Reference getProfile()
```
    Returns:
    
    profile (If specified, this indicates a profile that the input data must conform to, or that the output data will conform to.)
  - hasProfile
```
public boolean hasProfile()
```
  - setProfile
```
public ParameterDefinition setProfile(Reference 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.)
  - getProfileTarget
```
public StructureDefinition getProfileTarget()
```
    Returns:
    
    profile The actual object that is the target of the reference. The reference library doesn't populate this, but you can use it to hold the resource if you resolve it. (If specified, this indicates a profile that the input data must conform to, or that the output data will conform to.)
  - setProfileTarget
```
public ParameterDefinition setProfileTarget(StructureDefinition value)
```
    Parameters:
    
    value - profile The actual object that is the target of the reference. The reference library doesn't use these, but you can use it to hold the resource if you resolve it. (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> childrenList)
```
    Overrides:
    
    listChildren in class Element
  - getProperty
```
public Base[] getProperty(int hash,
                          String name,
                          boolean checkValid)
                   throws FHIRException
```
    Overrides:
    
    getProperty in class Element
    
    Throws:
    
    FHIRException
  - setProperty
```
public Base setProperty(int hash,
                        String name,
                        Base value)
                 throws FHIRException
```
    Overrides:
    
    setProperty in class Element
    
    Throws:
    
    FHIRException
  - setProperty
```
public Base setProperty(String name,
                        Base value)
                 throws FHIRException
```
    Overrides:
    
    setProperty in class Element
    
    Throws:
    
    FHIRException
  - makeProperty
```
public Base makeProperty(int hash,
                         String name)
                  throws FHIRException
```
    Overrides:
    
    makeProperty in class Element
    
    Throws:
    
    FHIRException
  - getTypesForProperty
```
public String[] getTypesForProperty(int hash,
                                    String name)
                             throws FHIRException
```
    Overrides:
    
    getTypesForProperty in class Element
    
    Throws:
    
    FHIRException
  - addChild
```
public Base addChild(String name)
              throws FHIRException
```
    Overrides:
    
    addChild in class Element
    
    Throws:
    
    FHIRException
  - fhirType
```
public String fhirType()
```
    Overrides:
    
    fhirType in class Element
  - copy
```
public ParameterDefinition copy()
```
    Overrides:
    
    copy in class Type
  - typedCopy
```
protected ParameterDefinition typedCopy()
```
    Specified by:
    
    typedCopy in class Type
  - 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 IBase
    
    Overrides:
    
    isEmpty in class Element

Class ParameterDefinition

Nested Class Summary

Field Summary

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

Constructor Summary

Method Summary

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

Methods inherited from class org.hl7.fhir.dstu3.model.Base

Methods inherited from class java.lang.Object

Methods inherited from interface org.hl7.fhir.instance.model.api.IBase

Field Detail

name

use

min

max

documentation

type

profile

profileTarget

Constructor Detail

ParameterDefinition

ParameterDefinition

Method Detail

getNameElement

hasNameElement

hasName

setNameElement

getName

setName

getUseElement

hasUseElement

hasUse

setUseElement

getUse

setUse

getMinElement

hasMinElement

hasMin

setMinElement

getMin

setMin

getMaxElement

hasMaxElement

hasMax

setMaxElement

getMax

setMax

getDocumentationElement

hasDocumentationElement

hasDocumentation

setDocumentationElement

getDocumentation

setDocumentation

getTypeElement

hasTypeElement

hasType

setTypeElement

getType

setType

getProfile

hasProfile

setProfile

getProfileTarget

setProfileTarget

listChildren

getProperty

setProperty

setProperty

makeProperty

getTypesForProperty

addChild

fhirType

copy

typedCopy

equalsDeep

equalsShallow

isEmpty