OperationDefinition constructor

const 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).

resourceType This is a OperationDefinition resource

id The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

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.

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.

implicitRulesElement Extensions for implicitRules

language The base language in which the resource is written.

languageElement Extensions for language

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.

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.

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.

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).

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.

urlElement Extensions for url

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.

versionElement Extensions for version

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.

nameElement Extensions for name

title A short, descriptive, user-friendly title for the operation definition.

titleElement Extensions for title

status The status of this operation definition. Enables tracking the life-cycle of the content.

statusElement Extensions for status

kind Whether this is an operation or a named query.

kindElement Extensions for kind

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.

experimentalElement Extensions for experimental

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.

dateElement Extensions for date

publisher The name of the organization or individual that published the operation definition.

publisherElement Extensions for publisher

contact Contact details to assist a user in finding and communicating with the publisher.

description A free text natural language description of the operation definition from a consumer's perspective.

descriptionElement Extensions for description

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.

jurisdiction A legal or geographic region in which the operation definition is intended to be used.

purpose Explanation of why this operation definition is needed and why it has been designed as it has.

purposeElement Extensions for purpose

affectsState Whether the operation affects state. Side effects such as producing audit trail entries do not count as 'affecting state'.

affectsStateElement Extensions for affectsState

code The name used to invoke the operation.

codeElement Extensions for code

comment Additional information about how to use this operation or named query.

commentElement Extensions for comment

base Indicates that this operation definition is a constraining profile on the base.

resource The types on which this operation can be executed.

resourceElement Extensions for resource

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).

systemElement Extensions for system

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).

typeElement Extensions for type

instance Indicates whether this operation can be invoked on a particular instance of one of the given types.

instanceElement Extensions for instance

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.

outputProfile Additional validation information for the out parameters

• a single profile that covers all the parameters. The profile is a constraint on the parameters resource.

parameter The parameters for the operation/query.

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.

Implementation

const factory OperationDefinition({
  @Default(R4ResourceType.OperationDefinition)
  @JsonKey(unknownEnumValue: R4ResourceType.OperationDefinition)

  /// [resourceType] This is a OperationDefinition resource
  R4ResourceType resourceType,
  @JsonKey(includeFromJson: true, includeToJson: false) int? dbId,

  /// [id] The logical id of the resource, as used in the URL for the resource.
  ///  Once assigned, this value never changes.
  @JsonKey(name: 'id') String? fhirId,

  /// [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.
  FhirMeta? meta,

  /// [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.
  FhirUri? implicitRules,

  /// [implicitRulesElement] Extensions for implicitRules
  @JsonKey(name: '_implicitRules') Element? implicitRulesElement,

  /// [language] The base language in which the resource is written.
  FhirCode? language,

  /// [languageElement] Extensions for language
  @JsonKey(name: '_language') Element? languageElement,

  /// [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.
  Narrative? text,

  /// [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.
  List<Resource>? contained,

  /// [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.
  @JsonKey(name: 'extension') List<FhirExtension>? extension_,

  /// [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).
  List<FhirExtension>? modifierExtension,

  /// [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.
  FhirUri? url,

  /// [urlElement] Extensions for url
  @JsonKey(name: '_url') Element? urlElement,

  /// [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.
  String? version,

  /// [versionElement] Extensions for version
  @JsonKey(name: '_version') Element? versionElement,

  /// [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.
  String? name,

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

  /// [title] A short, descriptive, user-friendly title for the operation
  ///  definition.
  String? title,

  /// [titleElement] Extensions for title
  @JsonKey(name: '_title') Element? titleElement,

  /// [status] The status of this operation definition. Enables tracking the
  ///  life-cycle of the content.
  FhirCode? status,

  /// [statusElement] Extensions for status
  @JsonKey(name: '_status') Element? statusElement,

  /// [kind] Whether this is an operation or a named query.
  FhirCode? kind,

  /// [kindElement] Extensions for kind
  @JsonKey(name: '_kind') Element? kindElement,

  /// [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.
  FhirBoolean? experimental,

  /// [experimentalElement] Extensions for experimental
  @JsonKey(name: '_experimental') Element? experimentalElement,

  /// [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.
  FhirDateTime? date,

  /// [dateElement] Extensions for date
  @JsonKey(name: '_date') Element? dateElement,

  /// [publisher] The name of the organization or individual that published the
  ///  operation definition.
  String? publisher,

  /// [publisherElement] Extensions for publisher
  @JsonKey(name: '_publisher') Element? publisherElement,

  /// [contact] Contact details to assist a user in finding and communicating
  ///  with the publisher.
  List<ContactDetail>? contact,

  /// [description] A free text natural language description of the operation
  ///  definition from a consumer's perspective.
  FhirMarkdown? description,

  /// [descriptionElement] Extensions for description
  @JsonKey(name: '_description') Element? descriptionElement,

  /// [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.
  List<UsageContext>? useContext,

  /// [jurisdiction] A legal or geographic region in which the operation
  ///  definition is intended to be used.
  List<CodeableConcept>? jurisdiction,

  /// [purpose] Explanation of why this operation definition is needed and why
  ///  it has been designed as it has.
  FhirMarkdown? purpose,

  /// [purposeElement] Extensions for purpose
  @JsonKey(name: '_purpose') Element? purposeElement,

  /// [affectsState] Whether the operation affects state. Side effects such as
  ///  producing audit trail entries do not count as 'affecting  state'.
  FhirBoolean? affectsState,

  /// [affectsStateElement] Extensions for affectsState
  @JsonKey(name: '_affectsState') Element? affectsStateElement,

  /// [code] The name used to invoke the operation.
  FhirCode? code,

  /// [codeElement] Extensions for code
  @JsonKey(name: '_code') Element? codeElement,

  /// [comment] Additional information about how to use this operation or named
  ///  query.
  FhirMarkdown? comment,

  /// [commentElement] Extensions for comment
  @JsonKey(name: '_comment') Element? commentElement,

  /// [base] Indicates that this operation definition is a constraining profile
  ///  on the base.
  FhirCanonical? base,

  /// [resource] The types on which this operation can be executed.
  List<FhirCode>? resource,

  /// [resourceElement] Extensions for resource
  @JsonKey(name: '_resource') List<Element?>? resourceElement,

  /// [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).
  FhirBoolean? system,

  /// [systemElement] Extensions for system
  @JsonKey(name: '_system') Element? systemElement,

  /// [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).
  FhirBoolean? type,

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

  /// [instance] Indicates whether this operation can be invoked on a
  ///  particular instance of one of the given types.
  FhirBoolean? instance,

  /// [instanceElement] Extensions for instance
  @JsonKey(name: '_instance') Element? instanceElement,

  /// [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.
  FhirCanonical? inputProfile,

  /// [outputProfile] Additional validation information for the out parameters
  /// - a single profile that covers all the parameters. The profile is a
  ///  constraint on the parameters resource.
  FhirCanonical? outputProfile,

  /// [parameter] The parameters for the operation/query.
  List<OperationDefinitionParameter>? parameter,

  /// [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.
  List<OperationDefinitionOverload>? overload,
}) = _OperationDefinition;