Package org.hl7.fhir.dstu3.model

Class ParameterDefinition

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:
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 Type implements org.hl7.fhir.instance.model.api.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:

  • 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<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 Details

  • 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<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> 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

    • 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 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 org.hl7.fhir.instance.model.api.IBase
      Overrides:
      isEmpty in class Element