OperationDefinitionParameter class
OperationDefinitionParameter A formal computable definition of an operation (on the RESTful interface) or a named query (using the search interaction).
- Annotations
-
- @freezed
Constructors
-
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).
constfactory
-
OperationDefinitionParameter.fromJson(Map<
String, dynamic> json) -
Factory constructor, accepts Map<String, dynamic> as an argument
factory
- OperationDefinitionParameter.fromJsonString(String source)
-
Acts like a constructor, returns a OperationDefinitionParameter,
accepts a
String as an argument, mostly because I got tired of typing it out
factory
- OperationDefinitionParameter.fromYaml(dynamic yaml)
-
Factory constructor that accepts a String in YAML format as an argument
factory
Properties
-
allowedType
→ List<
FhirCode> ? -
allowedType Support for polymorphic types. If the parameter type is
abstract, this element lists allowed sub-types for the parameter.
no setterinherited
-
allowedTypeElement
→ List<
Element> ? -
allowedTypeElement ("_allowedType") Extensions for allowedType
no setterinherited
- binding → OperationDefinitionBinding?
-
binding Binds to a value set if this parameter is coded (code,
Coding, CodeableConcept).
no setterinherited
-
copyWith
→ $OperationDefinitionParameterCopyWith<
OperationDefinitionParameter> -
no setterinherited
- documentation → FhirMarkdown?
-
documentation Describes the meaning or use of this parameter.
no setterinherited
- documentationElement → Element?
-
documentationElement ("_documentation") Extensions for documentation
no setterinherited
-
extension_
→ List<
FhirExtension> ? -
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.
no setterinherited
- fhirId → String?
-
id Unique id for the element within a resource (for internal
references). This may be any string value that does not contain spaces.
no setterinherited
- hashCode → int
-
The hash code for this object.
no setterinherited
- max → String?
-
max The maximum number of times this element is permitted to appear
in the request or response.
no setterinherited
- maxElement → Element?
-
maxElement ("_max") Extensions for max
no setterinherited
- min → FhirInteger?
-
min The minimum number of times this parameter SHALL appear in the
request or response.
no setterinherited
- minElement → Element?
-
minElement ("_min") Extensions for min
no setterinherited
-
modifierExtension
→ List<
FhirExtension> ? -
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).
no setterinherited
- name → FhirCode?
-
name The name of used to identify the parameter.
no setterinherited
- nameElement → Element?
-
nameElement ("_name") Extensions for name
no setterinherited
-
part_
→ List<
OperationDefinitionParameter> ? -
part_ ("part") The parts of a nested Parameter.
no setterinherited
-
referencedFrom
→ List<
OperationDefinitionReferencedFrom> ? -
referencedFrom Identifies other resource parameters within the
operation invocation that are expected to resolve to this resource.
no setterinherited
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
-
scope
→ List<
FhirCode> ? -
scope If present, indicates that the parameter applies when the
operation is being invoked at the specified level.
no setterinherited
-
scopeElement
→ List<
Element> ? -
scopeElement ("_scope") Extensions for scope
no setterinherited
- searchType → FhirCode?
-
searchType How the parameter is understood if/when it used as search
parameter. This is only used if the parameter is a string.
no setterinherited
- searchTypeElement → Element?
-
searchTypeElement ("_searchType") Extensions for searchType
no setterinherited
-
targetProfile
→ List<
FhirCanonical> ? -
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.
no setterinherited
- type → FhirCode?
-
type The type for this parameter.
no setterinherited
- typeElement → Element?
-
typeElement ("_type") Extensions for type
no setterinherited
- use → FhirCode?
-
use Whether this is an input or an output parameter.
no setterinherited
- useElement → Element?
-
useElement ("_use") Extensions for use
no setterinherited
Methods
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
toJson(
) → Map< String, dynamic> -
inherited
-
toJsonString(
) → String - Another convenience method because more and more I'm transmitting FHIR data as a String and not a Map
-
toString(
) → String -
A string representation of this object.
inherited
-
toYaml(
) → String - Produces a Yaml formatted String version of the object
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited