Class 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:
    Serialized Form
    • Field Detail

      • name

        protected CodeType name
        The name of the parameter used to allow access to the value of the parameter in evaluation contexts.
      • 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.
      • 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.)
    • 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
      • 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.
      • hasUse

        public boolean hasUse()
      • 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
      • 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
      • 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
      • 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.
      • 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
      • 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.
      • 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.)
      • 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.)
      • 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
      • 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
      • isEmpty

        public boolean isEmpty()
        Specified by:
        isEmpty in interface org.hl7.fhir.instance.model.api.IBase
        Overrides:
        isEmpty in class Element