Skip to main content

ParameterDefinition

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. If the element is present, it must have a value for at least one of the defined elements, an @id referenced from the Narrative, or extensions

type ParameterDefinition implements Element {
  name: String
  use: String
  min: Int
  max: String
  documentation: String
  type: String
  profile: Uri
  extension: [Extension]
  id: String
}

Fields​

ParameterDefinition.name ● String scalar​

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

ParameterDefinition.use ● String scalar​

Whether the parameter is input or output for the module.

ParameterDefinition.min ● Int scalar​

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

ParameterDefinition.max ● String scalar​

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

ParameterDefinition.documentation ● String scalar​

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

ParameterDefinition.type ● String scalar​

The type of the parameter.

ParameterDefinition.profile ● Uri scalar​

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

ParameterDefinition.extension ● [Extension] list object​

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

ParameterDefinition.id ● String scalar​

Interfaces​

Element interface​

Base definition for all elements in a resource. If the element is present, it must have a value for at least one of the defined elements, an @id referenced from the Narrative, or extensions

Member Of​

ElementDefinition object ● ElementDefinitionExample object ● Extension object ● Library object ● StructureMapSource object ● TaskInput object ● TaskOutput object