OperationDefinitionParameter constructor

const OperationDefinitionParameter({ @JsonKey(name: 'id') String? fhirId, @JsonKey(name: 'extension') List<FhirExtension>? extension_, List<FhirExtension>? modifierExtension, FhirCode? name, @JsonKey(name: '_name') Element? nameElement, FhirCode? use, @JsonKey(name: '_use') Element? useElement, List<FhirCode>? scope, @JsonKey(name: '_scope') List<Element>? scopeElement, FhirInteger? min, @JsonKey(name: '_min') Element? minElement, String? max, @JsonKey(name: '_max') Element? maxElement, FhirMarkdown? documentation, @JsonKey(name: '_documentation') Element? documentationElement, FhirCode? type, @JsonKey(name: '_type') Element? typeElement, List<FhirCode>? allowedType, @JsonKey(name: '_allowedType') List<Element>? allowedTypeElement, List<FhirCanonical>? targetProfile, FhirCode? searchType, @JsonKey(name: '_searchType') Element? searchTypeElement, OperationDefinitionBinding? binding, List<OperationDefinitionReferencedFrom>? referencedFrom, @JsonKey(name: 'part') List<OperationDefinitionParameter>? part_, })

OperationDefinitionParameter A formal computable definition of an operation (on the RESTful interface) or a named query (using the search interaction).

id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

extension_ ("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 managable, 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.

modifierExtension May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, 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. Applications processing a resource are required to check for modifier extensions.Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

name The name of used to identify the parameter.

nameElement ("_name") Extensions for name

use Whether this is an input or an output parameter.

useElement ("_use") Extensions for use

scope If present, indicates that the parameter applies when the operation is being invoked at the specified level.

scopeElement ("_scope") Extensions for scope

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

minElement ("_min") Extensions for min

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

maxElement ("_max") Extensions for max

documentation Describes the meaning or use of this parameter.

documentationElement ("_documentation") Extensions for documentation

type The type for this parameter.

typeElement ("_type") Extensions for type

allowedType Support for polymorphic types. If the parameter type is abstract, this element lists allowed sub-types for the parameter.

allowedTypeElement ("_allowedType") Extensions for allowedType

targetProfile Used when the type is "Reference" or "canonical", and identifies a profile structure or implementation Guide that applies to the target of the reference this parameter refers to. If any profiles are specified, then the content must conform to at least one of them. The URL can be a local reference - to a contained StructureDefinition, or a reference to another StructureDefinition or Implementation Guide by a canonical URL. When an implementation guide is specified, the target resource SHALL conform to at least one profile defined in the implementation guide.

searchType How the parameter is understood if/when it used as search parameter. This is only used if the parameter is a string.

searchTypeElement ("_searchType") Extensions for searchType

binding Binds to a value set if this parameter is coded (code, Coding, CodeableConcept).

referencedFrom Identifies other resource parameters within the operation invocation that are expected to resolve to this resource.

part_ ("part") The parts of a nested Parameter.

Implementation

const factory OperationDefinitionParameter({
  /// [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_] ("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 managable, 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_,

  /// [modifierExtension] May be used to represent additional information
  ///  that is not part of the basic definition of the element and that
  ///  modifies the understanding of the element in which it is contained
  ///  and/or the understanding of the containing element's descendants.
  ///  Usually modifier elements provide negation or qualification. To make
  ///  the use of extensions safe and managable, 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.
  ///  Applications processing a resource are required to check for modifier
  ///  extensions.Modifier extensions SHALL NOT change the meaning of any
  ///  elements on Resource or DomainResource (including cannot change the
  ///  meaning of modifierExtension itself).
  List<FhirExtension>? modifierExtension,

  /// [name] The name of used to identify the parameter.
  FhirCode? name,

  /// [nameElement] ("_name") Extensions for name
  @JsonKey(name: '_name') Element? nameElement,

  /// [use] Whether this is an input or an output parameter.
  FhirCode? use,

  /// [useElement] ("_use") Extensions for use
  @JsonKey(name: '_use') Element? useElement,

  /// [scope] If present, indicates that the parameter applies when the
  ///  operation is being invoked at the specified level.
  List<FhirCode>? scope,

  /// [scopeElement] ("_scope") Extensions for scope
  @JsonKey(name: '_scope') List<Element>? scopeElement,

  /// [min] The minimum number of times this parameter SHALL appear in the
  ///  request or response.
  FhirInteger? min,

  /// [minElement] ("_min") 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] ("_max") Extensions for max
  @JsonKey(name: '_max') Element? maxElement,

  /// [documentation] Describes the meaning or use of this parameter.
  FhirMarkdown? documentation,

  /// [documentationElement] ("_documentation") Extensions for documentation
  @JsonKey(name: '_documentation') Element? documentationElement,

  /// [type] The type for this parameter.
  FhirCode? type,

  /// [typeElement] ("_type") Extensions for type
  @JsonKey(name: '_type') Element? typeElement,

  /// [allowedType] Support for polymorphic types. If the parameter type is
  ///  abstract, this element lists allowed sub-types for the parameter.
  List<FhirCode>? allowedType,

  /// [allowedTypeElement] ("_allowedType") Extensions for allowedType
  @JsonKey(name: '_allowedType') List<Element>? allowedTypeElement,

  /// [targetProfile] Used when the type is "Reference" or "canonical", and
  ///  identifies a profile structure or implementation Guide that applies to
  ///  the target of the reference this parameter refers to. If any profiles
  ///  are specified, then the content must conform to at least one of them.
  ///  The URL can be a local reference - to a contained StructureDefinition,
  ///  or a reference to another StructureDefinition or Implementation Guide
  ///  by a canonical URL. When an implementation guide is specified, the
  ///  target resource SHALL conform to at least one profile defined in the
  ///  implementation guide.
  List<FhirCanonical>? targetProfile,

  /// [searchType] How the parameter is understood if/when it used as search
  ///  parameter. This is only used if the parameter is a string.
  FhirCode? searchType,

  /// [searchTypeElement] ("_searchType") Extensions for searchType
  @JsonKey(name: '_searchType') Element? searchTypeElement,

  /// [binding] Binds to a value set if this parameter is coded (code,
  ///  Coding, CodeableConcept).
  OperationDefinitionBinding? binding,

  /// [referencedFrom] Identifies other resource parameters within the
  ///  operation invocation that are expected to resolve to this resource.
  List<OperationDefinitionReferencedFrom>? referencedFrom,

  /// [part_] ("part") The parts of a nested Parameter.
  @JsonKey(name: 'part') List<OperationDefinitionParameter>? part_,
}) = _OperationDefinitionParameter;