OperationDefinition

A formal computable definition of an operation (on the RESTful interface) or a named query (using the search interaction). If the element is present, it must have either a @value, an @id, or extensions

type OperationDefinition implements Resource {
  url: Uri
  version: String
  name: String
  title: String
  status: String
  kind: String
  experimental: Boolean
  date: Date
  publisher: String
  contact: [ContactDetail]
  description: String
  useContext: [UsageContext]
  jurisdiction: [CodeableConcept]
  purpose: String
  affectsState: Boolean
  code: String
  comment: String
  base: Uri
  resource: [String]
  system: Boolean
  type: Boolean
  instance: Boolean
  inputProfile: Uri
  outputProfile: Uri
  parameter: [OperationDefinitionParameter]
  overload: [OperationDefinitionOverload]
  text: Narrative
  contained: [Resource]
  extension: [Extension]
  modifierExtension: [Extension]
  id: String
  meta: Meta
  implicitRules: Uri
  language: String
}

Fields

OperationDefinition.url ● Uri scalar

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.

OperationDefinition.version ● String scalar

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.

OperationDefinition.name ● String scalar

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.

OperationDefinition.title ● String scalar

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

OperationDefinition.status ● String scalar

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

OperationDefinition.kind ● String scalar

Whether this is an operation or a named query.

OperationDefinition.experimental ● Boolean scalar

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.

OperationDefinition.date ● Date scalar

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.

OperationDefinition.publisher ● String scalar

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

OperationDefinition.contact ● [ContactDetail] list object

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

OperationDefinition.description ● String scalar

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

OperationDefinition.useContext ● [UsageContext] list object

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.

OperationDefinition.jurisdiction ● [CodeableConcept] list object

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

OperationDefinition.purpose ● String scalar

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

OperationDefinition.affectsState ● Boolean scalar

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

OperationDefinition.code ● String scalar

The name used to invoke the operation.

OperationDefinition.comment ● String scalar

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

OperationDefinition.base ● Uri scalar

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

OperationDefinition.resource ● [String] list scalar

The types on which this operation can be executed.

OperationDefinition.system ● Boolean scalar

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

OperationDefinition.type ● Boolean scalar

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

OperationDefinition.instance ● Boolean scalar

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

OperationDefinition.inputProfile ● Uri scalar

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.

OperationDefinition.outputProfile ● Uri scalar

Additional validation information for the out parameters - a single profile that covers all the parameters. The profile is a constraint on the parameters resource.

OperationDefinition.parameter ● [OperationDefinitionParameter] list object

The parameters for the operation/query.

OperationDefinition.overload ● [OperationDefinitionOverload] list object

Defines an appropriate combination of parameters to use when invoking this operation, to help code generators when generating overloaded parameter sets for this operation.

OperationDefinition.text ● Narrative object

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.

OperationDefinition.contained ● [Resource] list interface

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.

OperationDefinition.extension ● [Extension] list object

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.

OperationDefinition.modifierExtension ● [Extension] list object

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

OperationDefinition.id ● String scalar

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

OperationDefinition.meta ● Meta object

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.

OperationDefinition.implicitRules ● Uri scalar

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.

OperationDefinition.language ● String scalar

The base language in which the resource is written.

Interfaces

Resource interface

This is the base resource type for everything.

Returned By

OperationDefinition query ● OperationDefinitionCreate mutation ● OperationDefinitionList query ● OperationDefinitionUpdate mutation