ParameterDefinition constructor
- @JsonKey(name: 'id') String? fhirId,
- @JsonKey(name: 'extension') List<
FhirExtension> ? extension_, - FhirCode? name,
- @JsonKey(name: '_name') Element? nameElement,
- FhirCode? use,
- @JsonKey(name: '_use') Element? useElement,
- FhirInteger? min,
- @JsonKey(name: '_min') Element? minElement,
- String? max,
- @JsonKey(name: '_max') Element? maxElement,
- String? documentation,
- @JsonKey(name: '_documentation') Element? documentationElement,
- FhirCode? type,
- @JsonKey(name: '_type') Element? typeElement,
- FhirCanonical? profile,
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.
id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
extension_
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.
name
The name of the parameter used to allow access to the value of the
parameter in evaluation contexts.
nameElement
Extensions for name
use
Whether the parameter is input or output for the module.
useElement
Extensions for use
min
The minimum number of times this parameter SHALL appear in the
request or response.
minElement
Extensions for min
max
The maximum number of times this element is permitted to appear in
the request or response.
maxElement
Extensions for max
documentation
A brief discussion of what the parameter is for and how
it is used by the module.
documentationElement
Extensions for documentation
type
The type of the parameter.
typeElement
Extensions for type
profile
If specified, this indicates a profile that the input data must
conform to, or that the output data will conform to.
Implementation
const factory ParameterDefinition({
/// [id] Unique id for the element within a resource (for internal
/// references). This may be any string value that does not contain spaces.
@JsonKey(name: 'id') String? fhirId,
/// [extension_] 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.
@JsonKey(name: 'extension') List<FhirExtension>? extension_,
/// [name] The name of the parameter used to allow access to the value of the
/// parameter in evaluation contexts.
FhirCode? name,
/// [nameElement] Extensions for name
@JsonKey(name: '_name') Element? nameElement,
/// [use] Whether the parameter is input or output for the module.
FhirCode? use,
/// [useElement] Extensions for use
@JsonKey(name: '_use') Element? useElement,
/// [min] The minimum number of times this parameter SHALL appear in the
/// request or response.
FhirInteger? min,
/// [minElement] Extensions for min
@JsonKey(name: '_min') Element? minElement,
/// [max] The maximum number of times this element is permitted to appear in
/// the request or response.
String? max,
/// [maxElement] Extensions for max
@JsonKey(name: '_max') Element? maxElement,
/// [documentation] A brief discussion of what the parameter is for and how
/// it is used by the module.
String? documentation,
/// [documentationElement] Extensions for documentation
@JsonKey(name: '_documentation') Element? documentationElement,
/// [type] The type of the parameter.
FhirCode? type,
/// [typeElement] Extensions for type
@JsonKey(name: '_type') Element? typeElement,
/// [profile] If specified, this indicates a profile that the input data must
/// conform to, or that the output data will conform to.
FhirCanonical? profile,
}) = _ParameterDefinition;