OperationDefinition class
OperationDefinition A formal computable definition of an operation (on
- Mixed in types
- Annotations
-
- @freezed
Constructors
-
OperationDefinition({@Default(R4ResourceType.OperationDefinition) @JsonKey(unknownEnumValue: R4ResourceType.OperationDefinition) R4ResourceType resourceType, @JsonKey(includeFromJson: true, includeToJson: false) int? dbId, @JsonKey(name: 'id') String? fhirId, FhirMeta? meta, FhirUri? implicitRules, @JsonKey(name: '_implicitRules') Element? implicitRulesElement, FhirCode? language, @JsonKey(name: '_language') Element? languageElement, Narrative? text, List<
Resource> ? contained, @JsonKey(name: 'extension') List<FhirExtension> ? extension_, List<FhirExtension> ? modifierExtension, FhirUri? url, @JsonKey(name: '_url') Element? urlElement, String? version, @JsonKey(name: '_version') Element? versionElement, String? name, @JsonKey(name: '_name') Element? nameElement, String? title, @JsonKey(name: '_title') Element? titleElement, FhirCode? status, @JsonKey(name: '_status') Element? statusElement, FhirCode? kind, @JsonKey(name: '_kind') Element? kindElement, FhirBoolean? experimental, @JsonKey(name: '_experimental') Element? experimentalElement, FhirDateTime? date, @JsonKey(name: '_date') Element? dateElement, String? publisher, @JsonKey(name: '_publisher') Element? publisherElement, List<ContactDetail> ? contact, FhirMarkdown? description, @JsonKey(name: '_description') Element? descriptionElement, List<UsageContext> ? useContext, List<CodeableConcept> ? jurisdiction, FhirMarkdown? purpose, @JsonKey(name: '_purpose') Element? purposeElement, FhirBoolean? affectsState, @JsonKey(name: '_affectsState') Element? affectsStateElement, FhirCode? code, @JsonKey(name: '_code') Element? codeElement, FhirMarkdown? comment, @JsonKey(name: '_comment') Element? commentElement, FhirCanonical? base, List<FhirCode> ? resource, @JsonKey(name: '_resource') List<Element?> ? resourceElement, FhirBoolean? system, @JsonKey(name: '_system') Element? systemElement, FhirBoolean? type, @JsonKey(name: '_type') Element? typeElement, FhirBoolean? instance, @JsonKey(name: '_instance') Element? instanceElement, FhirCanonical? inputProfile, FhirCanonical? outputProfile, List<OperationDefinitionParameter> ? parameter, List<OperationDefinitionOverload> ? overload}) -
OperationDefinition A formal computable definition of an operation (on
the RESTful interface) or a named query (using the search interaction).
constfactory
-
OperationDefinition.fromJson(Map<
String, dynamic> json) -
Factory constructor, accepts Map<String, dynamic> as an argument
factory
- OperationDefinition.fromJsonString(String source)
-
Acts like a constructor, returns a OperationDefinition, accepts a
String as an argument, mostly because I got tired of typing it out
factory
- OperationDefinition.fromYaml(dynamic yaml)
-
Factory constructor that accepts a String in YAML format as an argument
factory
Properties
- affectsState → FhirBoolean?
-
affectsState Whether the operation affects state. Side effects such as
producing audit trail entries do not count as 'affecting state'.
no setterinherited
- affectsStateElement → Element?
-
affectsStateElement Extensions for affectsState
no setterinherited
- base → FhirCanonical?
-
base Indicates that this operation definition is a constraining profile
on the base.
no setterinherited
- code → FhirCode?
-
code The name used to invoke the operation.
no setterinherited
- codeElement → Element?
-
codeElement Extensions for code
no setterinherited
- comment → FhirMarkdown?
-
comment Additional information about how to use this operation or named
query.
no setterinherited
- commentElement → Element?
-
commentElement Extensions for comment
no setterinherited
-
contact
→ List<
ContactDetail> ? -
contact Contact details to assist a user in finding and communicating
with the publisher.
no setterinherited
-
contained
→ List<
Resource> ? -
contained These resources do not have an independent existence apart
from the resource that contains them - they cannot be identified
independently, and nor can they have their own independent transaction
scope.
no setterinherited
-
copyWith
→ $OperationDefinitionCopyWith<
OperationDefinition> -
no setterinherited
- date → FhirDateTime?
-
date The date (and optionally time) when the operation definition was
published. The date must change when the business version changes and it
must change if the status code changes. In addition, it should change when
the substantive content of the operation definition changes.
no setterinherited
- dateElement → Element?
-
dateElement Extensions for date
no setterinherited
- dbId → int?
-
no setterinherited
- description → FhirMarkdown?
-
description A free text natural language description of the operation
definition from a consumer's perspective.
no setterinherited
- descriptionElement → Element?
-
descriptionElement Extensions for description
no setterinherited
- experimental → FhirBoolean?
-
experimental A Boolean value to indicate that this operation definition
is authored for testing purposes (or education/evaluation/marketing) and
is not intended to be used for genuine usage.
no setterinherited
- experimentalElement → Element?
-
experimentalElement Extensions for experimental
no setterinherited
-
extension_
→ List<
FhirExtension> ? -
extension_ May be used to represent additional information that is not
part of the basic definition of the resource. 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.
no setterinherited
- fhirId → String?
-
id The logical id of the resource, as used in the URL for the resource.
Once assigned, this value never changes.
no setterinherited
- hashCode → int
-
The hash code for this object.
no setterinherited
- implicitRules → FhirUri?
-
implicitRules A reference to a set of rules that were followed when the
resource was constructed, and which must be understood when processing the
content. Often, this is a reference to an implementation guide that
defines the special rules along with other profiles etc.
no setterinherited
- implicitRulesElement → Element?
-
implicitRulesElement Extensions for implicitRules
no setterinherited
- inputProfile → FhirCanonical?
-
inputProfile Additional validation information for the in parameters -
a single profile that covers all the parameters. The profile is a
constraint on the parameters resource as a whole.
no setterinherited
- instance → FhirBoolean?
-
instance Indicates whether this operation can be invoked on a
particular instance of one of the given types.
no setterinherited
- instanceElement → Element?
-
instanceElement Extensions for instance
no setterinherited
-
jurisdiction
→ List<
CodeableConcept> ? -
jurisdiction A legal or geographic region in which the operation
definition is intended to be used.
no setterinherited
- kind → FhirCode?
-
kind Whether this is an operation or a named query.
no setterinherited
- kindElement → Element?
-
kindElement Extensions for kind
no setterinherited
- language → FhirCode?
-
language The base language in which the resource is written.
no setterinherited
- languageElement → Element?
-
languageElement Extensions for language
no setterinherited
- meta → FhirMeta?
-
meta The metadata about the resource. This is content that is
maintained by the infrastructure. Changes to the content might not always
be associated with version changes to the resource.
no setterinherited
-
modifierExtension
→ List<
FhirExtension> ? -
modifierExtension May be used to represent additional information that
is not part of the basic definition of the resource and that modifies the
understanding of the element that contains it 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
manageable, there is a strict set of governance applied to the definition
and use of extensions. Though any implementer is allowed to 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 → String?
-
name A natural language name identifying the operation definition. This
name should be usable as an identifier for the module by machine
processing applications such as code generation.
no setterinherited
- nameElement → Element?
-
nameElement Extensions for name
no setterinherited
- outputProfile → FhirCanonical?
-
outputProfile Additional validation information for the out parameters
no setterinherited
-
overload
→ List<
OperationDefinitionOverload> ? -
overload Defines an appropriate combination of parameters to use when
invoking this operation, to help code generators when generating
overloaded parameter sets for this operation.
no setterinherited
-
parameter
→ List<
OperationDefinitionParameter> ? -
parameter The parameters for the operation/query.
no setterinherited
- path → String
-
Local Reference for this Resource, form is "ResourceType/Id"
no setterinherited
- publisher → String?
-
publisher The name of the organization or individual that published the
operation definition.
no setterinherited
- publisherElement → Element?
-
publisherElement Extensions for publisher
no setterinherited
- purpose → FhirMarkdown?
-
purpose Explanation of why this operation definition is needed and why
it has been designed as it has.
no setterinherited
- purposeElement → Element?
-
purposeElement Extensions for purpose
no setterinherited
-
resource
→ List<
FhirCode> ? -
resource The types on which this operation can be executed.
no setterinherited
-
resourceElement
→ List<
Element?> ? -
resourceElement Extensions for resource
no setterinherited
- resourceType → R4ResourceType
-
no setterinherited
- resourceTypeString → String?
-
produce a string of the resourceType
no setterinherited
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- status → FhirCode?
-
status The status of this operation definition. Enables tracking the
life-cycle of the content.
no setterinherited
- statusElement → Element?
-
statusElement Extensions for status
no setterinherited
- system → FhirBoolean?
-
system Indicates whether this operation or named query can be invoked
at the system level (e.g. without needing to choose a resource type for
the context).
no setterinherited
- systemElement → Element?
-
systemElement Extensions for system
no setterinherited
- text → Narrative?
-
text A human-readable narrative that contains a summary of the resource
and can be used to represent the content of the resource to a human. The
narrative need not encode all the structured data, but is required to
contain sufficient detail to make it "clinically safe" for a human to just
read the narrative. Resource definitions may define what content should be
represented in the narrative to ensure clinical safety.
no setterinherited
- thisReference → Reference
-
Convenience method to return a Reference referring to that Resource
no setterinherited
- title → String?
-
title A short, descriptive, user-friendly title for the operation
definition.
no setterinherited
- titleElement → Element?
-
titleElement Extensions for title
no setterinherited
- type → FhirBoolean?
-
type Indicates whether this operation or named query can be invoked at
the resource type level for any given resource type level (e.g. without
needing to choose a specific resource id for the context).
no setterinherited
- typeElement → Element?
-
typeElement Extensions for type
no setterinherited
- url → FhirUri?
-
url An absolute URI that is used to identify this operation definition
when it is referenced in a specification, model, design or an instance;
also called its canonical identifier. This SHOULD be globally unique and
SHOULD be a literal address at which at which an authoritative instance of
this operation definition is (or will be) published. This URL can be the
target of a canonical reference. It SHALL remain the same when the
operation definition is stored on different servers.
no setterinherited
- urlElement → Element?
-
urlElement Extensions for url
no setterinherited
-
useContext
→ List<
UsageContext> ? -
useContext The content was developed with a focus and intent of
supporting the contexts that are listed. These contexts may be general
categories (gender, age, ...) or may be references to specific programs
(insurance plans, studies, ...) and may be used to assist with indexing
and searching for appropriate operation definition instances.
no setterinherited
- version → String?
-
version The identifier that is used to identify this version of the
operation definition when it is referenced in a specification, model,
design or instance. This is an arbitrary value managed by the operation
definition author and is not expected to be globally unique. For example,
it might be a timestamp (e.g. yyyymmdd) if a managed version is not
available. There is also no expectation that versions can be placed in a
lexicographical sequence.
no setterinherited
- versionElement → Element?
-
versionElement Extensions for version
no setterinherited
Methods
-
newId(
) → Resource -
returns the same resource with a new ID (even if there is already an ID
present)
inherited
-
newIdIfNoId(
) → Resource -
returns the same resource with a new ID if there is no current ID
inherited
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
toDbJson(
) → Map< String, dynamic> -
The normal toJson ignores the dbId, and produces the fhirId as the id
However, if you're going to use this as a database entry, you have to
switch those two ids
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
override
-
toString(
) → String -
A string representation of this object.
inherited
-
toYaml(
) → String -
Produces a Yaml formatted String version of the object
inherited
-
updateVersion(
{FhirMeta? oldMeta}) → Resource -
Updates the meta field of this Resource, updates the meta.lastUpdated
field, adds 1 to the version number
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited