Parameterdefinition-definitions

STU 3 Ballot

This page is part of the FHIR Specification (v1.6.0: STU 3 Ballot 4). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions

14.13.2 Parameter Definition Detailed Descriptions

Clinical Decision Support

Work Group

Maturity Level: N/A

Ballot Status: STU 3

14.13.2.1 ParameterDefinition

ParameterDefinition
Definition	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.
Control	1..1
Summary	true
ParameterDefinition.name
Definition	The name of the parameter.
Control	0..1
Type	code
Summary	true
ParameterDefinition.use
Definition	Whether the parameter is input or output for the module.
Control	1..1
Binding	OperationParameterUse: Whether the parameter is input or output (Required)
Type	code
Summary	true
ParameterDefinition.min
Definition	The minimum number of times this parameter SHALL appear in the request or response.
Control	0..1
Type	integer
Summary	true
ParameterDefinition.max
Definition	The maximum number of times this element is permitted to appear in the request or response.
Control	0..1
Type	string
Summary	true
ParameterDefinition.documentation
Definition	A brief discussion of what the parameter is for and how it is used by the module.
Control	0..1
Type	string
Summary	true
ParameterDefinition.type
Definition	The type of the parameter.
Control	1..1
Binding	FHIRAllTypes: Any defined Resource or Data Type name (including "Any" and "Type")
Type	code
Summary	true
ParameterDefinition.profile
Definition	If specified, this indicates a profile that the input data must conform to, or that the output data will conform to.
Control	0..1
Type	Reference(StructureDefinition)
Summary	true