type: resource-definitionsresource: OperationDefinition

OperationDefinition Definitions

OperationDefinition

Definition of an operation or a named query

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

Cardinality: 0..*

Constraints: cnl-0 | warning | Name should be usable as an identifier for the module by machine processing applications such as code generation | name.exists() implies name.matches('^A-Z{1,254}$'); opd-5 | error | A query operation cannot be defined at the instance level | (kind = 'query') implies (instance = false); opd-6 | error | A query operation requires input parameters to have a search type | (kind = 'query') implies (parameter.all((use = 'in' and searchType.exists()) or (use != 'in'))); opd-7 | error | Named queries always have a single output parameter named 'result' of type Bundle | (kind = 'query') implies ((parameter.where(use = 'out').count() = 1) and (parameter.where(use = 'out').all(name = 'result' and type = 'Bundle')))

Mappings: workflow=Definition; rim=n/a; w5=conformance.behavior

OperationDefinition.url

Canonical identifier for this operation definition, represented as an absolute URI (globally unique)

Definition: 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 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.

Comments: Can be a urn:uuid: or a urn:oid: but real http: addresses are preferred. Multiple instances may share the same URL if they have a distinct version.

The determination of when to create a new version of a resource (same url, new version) vs. defining a new artifact is up to the author. Considerations for making this decision are found in Technical and Business Versions.

In some cases, the resource can no longer be found at the stated url, but the url itself cannot change. Implementations can use the meta.source element to indicate where the current master source of the resource can be found.

Requirements: Allows the operation definition to be referenced by a single globally unique identifier.

Cardinality: 0..1

Type: uri

Summary: true

Mappings: workflow=Definition.url; w5=FiveWs.identifier

OperationDefinition.identifier

Additional identifier for the implementation guide (business identifier)

Definition: A formal identifier that is used to identify this implementation guide when it is represented in other formats, or referenced in a specification, model, design or an instance.

Requirements: Allows externally provided and/or usable business identifiers to be easily associated with the module.

Cardinality: 0..*

Type: Identifier

Summary: true

Mappings: w5=FiveWs.identifier

OperationDefinition.version

Business version of the operation definition

Definition: 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.

Comments: There may be different operation definitions that have the same url but different versions. The version can be appended to the url in a reference to allow a reference to a particular business version of the operation definition with the format. The version SHOULD NOT contain a '#' - see Business Version.

Cardinality: 0..1

Type: string

Summary: true

Mappings: workflow=Definition.version; w5=FiveWs.version

OperationDefinition.versionAlgorithm[x]

How to compare versions

Definition: Indicates the mechanism used to compare versions to determine which is more current.

Comments: If set as a string, this is a FHIRPath expression that has two additional context variables passed in - %version1 and %version2 and will return a negative number if version1 is newer, a positive number if version2 and a 0 if the version ordering can't be successfully be determined.

Cardinality: 0..1

Type: string, Coding

Binding: extensible:version-algorithm

Summary: true

Mappings: workflow=Definition.versionAlgorithm

OperationDefinition.name

Name for this operation definition (computer friendly)

Definition: 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.

Comments: The name is not expected to be globally unique. The name should be a simple alphanumeric type no-whitespace name to ensure that it is machine-processing friendly.

Requirements: Support code generation.

Conditions: cnl-0

Cardinality: 1..1

Type: string

Summary: true

Mappings: workflow=Definition.name

OperationDefinition.title

Name for this operation definition (human friendly)

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

Comments: This name does not need to be machine-processing friendly and may contain punctuation, white-space, etc.

Cardinality: 0..1

Type: string

Summary: true

Mappings: workflow=Definition.title

OperationDefinition.status

draft | active | retired | unknown

Definition: The current state of this operation definition.

Comments: A nominal state-transition diagram can be found in the] documentation

Unknown does not represent 'other' - one of the defined statuses must apply. Unknown is used when the authoring system is not sure what the current status is.

Requirements: Enables tracking the lifecycle of the content and filtering of operation definitions that are appropriate for use versus not.

See guidance around (not) making local changes to elements here.

Cardinality: 1..1

Type: code

Binding: required:publication-status

Summary: true

Is Modifier: true (Reason: This is labeled as "Is Modifier" because applications should not use a retired {{title}} without due consideration)

Mappings: workflow=Definition.status {different ValueSet}; w5=FiveWs.status

OperationDefinition.kind

operation | query

Definition: Whether this is an operation or a named query.

Comments: Named queries are invoked differently, and have different capabilities.

Conditions: opd-5, opd-6, opd-7

Cardinality: 1..1

Type: code

Binding: required:operation-kind

Summary: true

Mappings: w5=FiveWs.class

OperationDefinition.experimental

For testing only - never for real usage

Definition: A Boolean value to indicate that this operation definition is authored for testing purposes (or education/evaluation/marketing) and no version of this resource will ever be intended for genuine usage.

Comments: Allows filtering of operation definitions that are appropriate for use versus not.. Experimental resources might include example instances in implementation guides, instances created solely for testing purposes, etc

Requirements: Enables experimental content to be developed following the same lifecycle that would be used for a production-level operation definition.

Meaning if Missing: If absent, this resource is treated as though it is not experimental.

Cardinality: 0..1

Type: boolean

Summary: true

Mappings: workflow=Definition.experimental; w5=FiveWs.class

OperationDefinition.date

Date last changed

Definition: The date (and optionally time) when the operation definition was last significantly changed. 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.

Comments: The date is often not tracked until the resource is published, but may be present on draft content. Note that this is not the same as the resource last-modified-date, since the resource may be a secondary representation of the operation definition. Additional specific dates may be added as extensions or be found by consulting Provenances associated with past versions of the resource.

See guidance around (not) making local changes to elements here.

Aliases: Revision Date

Cardinality: 0..1

Type: dateTime

Summary: true

Mappings: workflow=Definition.date; w5=FiveWs.recorded

OperationDefinition.publisher

Name of the publisher/steward (organization or individual)

Definition: The name of the organization or individual responsible for the release and ongoing maintenance of the operation definition.

Comments: Usually an organization but may be an individual. The publisher (or steward) of the operation definition is the organization or individual primarily responsible for the maintenance and upkeep of the operation definition. This is not necessarily the same individual or organization that developed and initially authored the content. The publisher is the primary point of contact for questions or issues with the operation definition. This item SHOULD be populated unless the information is available from context.

Requirements: Helps establish the "authority/credibility" of the operation definition. May also allow for contact.

Cardinality: 0..1

Type: string

Summary: true

Mappings: workflow=Definition.publisher; w5=FiveWs.witness

OperationDefinition.contact

Contact details for the publisher

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

Comments: May be a web site, an email address, a telephone number, etc.

See guidance around (not) making local changes to elements here.

Cardinality: 0..*

Type: ContactDetail

Summary: true

Mappings: workflow=Definition.contact

OperationDefinition.description

Natural language description of the operation definition

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

Comments: This description can be used to capture details such as comments about misuse, instructions for clinical use and interpretation, literature references, examples from the paper world, etc. It is not a rendering of the operation definition as conveyed in the 'text' field of the resource itself. This item SHOULD be populated unless the information is available from context (e.g. the language of the operation definition is presumed to be the predominant language in the place the operation definition was created).

Cardinality: 0..1

Type: markdown

Mappings: workflow=Definition.description

OperationDefinition.useContext

The context that the content is intended to support

Definition: 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.

Comments: When multiple useContexts are specified, there is no expectation that all or even any of the contexts apply.

Requirements: Assist in searching for appropriate content.

Cardinality: 0..*

Type: UsageContext

Summary: true

Mappings: workflow=Definition.useContext

OperationDefinition.jurisdiction

Jurisdiction of the authority that maintains the operation definition (if applicable)

Definition: A legal or geographic region in which the authority that maintains the resource is operating. In general, the jurisdiction is also found in the useContext. The useContext may reference additional jurisdictions because the defining jurisdiction does not necessarily limit the jurisdictions of use.

Comments: It may be possible for the operation definition to be used in jurisdictions other than those for which it was originally designed or intended.

DEPRECATION NOTE: For consistency, implementations are encouraged to migrate to using the new 'jurisdiction' code in the useContext element. (I.e. useContext.code indicating http://terminology.hl7.org/CodeSystem/usage-context-type#jurisdiction and useContext.valueCodeableConcept indicating the jurisdiction.)

Cardinality: 0..*

Type: CodeableConcept

Binding: extensible:jurisdiction

Summary: true

Mappings: workflow=Definition.jurisdiction

OperationDefinition.purpose

Why this operation definition is defined

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

Comments: This element does not describe the usage of the operation definition. Instead, it provides traceability of ''why'' the resource is either needed or ''why'' it is defined as it is. This may be used to point to source materials or specifications that drove the structure of this operation definition.

Cardinality: 0..1

Type: markdown

Mappings: workflow=Definition.purpose; w5=FiveWs.why[x]; objimpl=no-gen-base

OperationDefinition.copyright

Notice about intellectual property ownership, can include restrictions on use

Definition: A copyright statement relating to the operation definition and/or its contents. Copyright statements are notices of intellectual property ownership and can include restrictions on the use and publishing of the operation definition.

Requirements: Consumers of the operation definition must be able to determine any legal restrictions on the use of the artifact and/or its content.

Aliases: License, Restrictions

Cardinality: 0..1

Type: markdown

Mappings: workflow=Definition.copyright; objimpl=no-gen-base

OperationDefinition.copyrightLabel

Definition: A short string (<50 characters), suitable for inclusion in a page footer that identifies the copyright holder, effective period, and optionally whether rights are restricted. (e.g. 'All rights reserved', 'Some rights reserved').

Comments: The copyright symbol and the '(c)' textual representation SHOULD NOT be included in this string. It will be added by software when rendering the notation. Full details about licensing, restrictions, warrantees, etc. goes in the more general 'copyright' element.

Requirements: Defines the content expected to be rendered in all representations of the artifact.

Cardinality: 0..1

Type: string

Mappings: workflow=Definition.copyrightLabel

OperationDefinition.affectsState

Whether content is changed by the operation

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

Comments: What http methods can be used for the operation depends on the .affectsState value and whether the input parameters are primitive or complex:

Servers SHALL support POST method for all operations.
Servers SHALL support the GET method when the operation has affectsState = false and all required parameters for the operation are primitive.

Cardinality: 0..1

Type: boolean

Summary: true

OperationDefinition.synchronicity

synchronous | asynchronous | either

Definition: Indicates that this operation must always be handled as synchronous or asynchronous, or that the server must provide both options, and clients can choose.

Comments: An operation derived from another must be consistent with regard to synchronicity - it cannot change from synchronous to asynchronous or vice versa, but it may choose one if synchronicity is either or not specified

Meaning if Missing: It is up to server discretion whether to accept a particular invocation of the operation as synchronous or asynchronous.

Cardinality: 0..1

Type: code

Binding: required:synchronicity-control

Summary: true

OperationDefinition.code

Recommended name for operation in search url

Definition: The label that is recommended to be used in the URL for this operation. In some cases, servers may need to use a different CapabilityStatement operation.name to differentiate between multiple SearchParameters that happen to have the same code.

Comments: For maximum compatibility, use only lowercase ASCII characters. Note that HL7 will never define multiple operations with the same code. See Naming Rules & Guidelines for the internal HL7 rules around codes, which are useful additional advice for all implementers

Cardinality: 1..1

Type: code

Summary: true

Mappings: workflow=Definition.code

OperationDefinition.comment

Additional information about use

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

Cardinality: 0..1

Type: markdown

OperationDefinition.base

Marks this as a profile of the base

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

Comments: A constrained profile can make optional parameters required or not used, introduce new parameters (required or optional), and clarify documentation. This canonical reference SHOULD always be version-specific, as different versions of the base resource may have changes that would cause the derived operation to not be a valid derivation.

Cardinality: 0..1

Type: canonical

Summary: true

Mappings: workflow=Definition.derivedFromCanonical

OperationDefinition.resource

Types this operation applies to

Definition: The types on which this operation can be executed.

Comments: If the type is an abstract resource ("Resource" or "DomainResource") then the operation can be invoked on any concrete specialization.

Cardinality: 0..*

Type: code

Binding: required:version-independent-all-resource-types

Summary: true

OperationDefinition.system

Invoke at the system level?

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

Cardinality: 1..1

Type: boolean

Summary: true

OperationDefinition.type

Invoke at the type level?

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

Cardinality: 1..1

Type: boolean

Summary: true

OperationDefinition.instance

Invoke on an instance?

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

Conditions: opd-5

Cardinality: 1..1

Type: boolean

Summary: true

OperationDefinition.inputProfile

Validation information for in parameters

Definition: 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.

Comments: If present the profile shall not conflict with what is specified in the parameters in the operation definition (max/min etc.), though it may provide additional constraints. The constraints expressed in the profile apply whether the operation is invoked by a POST wih parameters or not.

Cardinality: 0..1

Type: canonical

OperationDefinition.outputProfile

Validation information for out parameters

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

Cardinality: 0..1

Type: canonical

OperationDefinition.parameter

Parameters for the operation/query

Definition: The parameters for the operation/query.

Comments: Query Definitions only have one output parameter, named "result". This might not be described, but can be to allow a profile to be defined.

Conditions: opd-7

Cardinality: 0..*

Type: BackboneElement

OperationDefinition.parameter.name

Name in Parameters.parameter.name or in URL

Definition: The name of used to identify the parameter.

Comments: This name must be a token (start with a letter in a..z or underscore and only contain letters, numerals, and underscore). Note that for search parameters (type = string, with a search type), the name may be altered by the search modifiers.

Conditions: opd-7

Cardinality: 1..1

Type: code

OperationDefinition.parameter.use

in | out

Definition: Whether this is an input or an output parameter.

Comments: If a parameter name is used for both an input and an output parameter, the parameter should be defined twice.

Conditions: opd-6, opd-7, opd-4

Cardinality: 1..1

Type: code

Binding: required:operation-parameter-use

OperationDefinition.parameter.scope

instance | type | system

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

Meaning if Missing: If no scope is indicated, it is assumed that the parameter is relevant whenever the operation is invoked.

Cardinality: 0..*

Type: code

Binding: required:operation-parameter-scope

OperationDefinition.parameter.min

Minimum Cardinality

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

Cardinality: 1..1

Type: unsignedInt

OperationDefinition.parameter.max

Maximum Cardinality (a number or *)

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

Cardinality: 1..1

Type: string

Constraints: opd-9 | error | Max SHALL be a number or "" | empty() or ($this = '') or (toInteger() >= 0)

OperationDefinition.parameter.documentation

Description of meaning/use

Definition: Describes the meaning or use of this parameter.

Cardinality: 0..1

Type: markdown

OperationDefinition.parameter.type

What type this parameter has

Definition: The type for this parameter.

Comments: if there is no stated parameter, then the parameter is a multi-part parameter type and must have at least one part defined.

Conditions: opd-7, opd-1, opd-2, opd-3

Cardinality: 0..1

Type: code

Binding: required:fhir-types

OperationDefinition.parameter.allowedType

Allowed sub-type this parameter can have (if type is abstract)

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

Comments: In previous versions of FHIR, there was an extension for this: http://hl7.org/fhir/StructureDefinition/operationdefinition-allowed-type

Cardinality: 0..*

Type: code

Binding: required:fhir-types

OperationDefinition.parameter.targetProfile

If type is Reference | canonical, allowed targets. If type is 'Resource', then this constrains the allowed resource types

Definition: 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.

Comments: Often, these profiles are the base definitions from the spec (e.g. http://hl7.org/fhir/StructureDefinition/Patient).

Conditions: opd-3

Cardinality: 0..*

Type: canonical

OperationDefinition.parameter.searchType

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

Comments: Parameters that are search parameter usually - but not always - are also defined for use with general searches, and function in the operation to filter the set of resources in scope for the operation just like the do when searching. The searchType describes how the server processes the value. For an example, see the Evaluate Measure Operation

Conditions: opd-6, opd-2, opd-4

Cardinality: 0..1

Type: code

Binding: required:search-param-type

OperationDefinition.parameter.binding

ValueSet details if this is coded

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

Cardinality: 0..1

Type: BackboneElement

OperationDefinition.parameter.binding.strength

required | extensible | preferred | example | descriptive

Definition: Indicates the degree of conformance expectations associated with this binding - that is, the degree to which the provided value set must be adhered to in the instances.

Comments: For further discussion, see Using Terminologies.

Aliases: conformance, extensibility

Cardinality: 1..1

Type: code

Binding: required:binding-strength

OperationDefinition.parameter.binding.valueSet

Source of value set

Definition: Points to the value set or external definition (e.g. implicit value set) that identifies the set of codes to be used.

Comments: For value sets with a referenceResource, the display can contain the value set description. The reference may be version-specific or not.

Cardinality: 1..1

Type: canonical

OperationDefinition.parameter.referencedFrom

References to this parameter

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

Comments: Resolution applies if the referenced parameter exists.

Cardinality: 0..*

Type: BackboneElement

OperationDefinition.parameter.referencedFrom.source

Referencing parameter

Definition: The name of the parameter or dot-separated path of parameter names pointing to the resource parameter that is expected to contain a reference to this resource.

Cardinality: 1..1

Type: string

OperationDefinition.parameter.referencedFrom.sourceId

Element id of reference

Definition: The id of the element in the referencing resource that is expected to resolve to this resource.

Cardinality: 0..1

Type: string

OperationDefinition.parameter.part

Parts of a nested Parameter

Definition: The parts of a nested Parameter.

Comments: Query Definitions only have one output parameter, named "result". This might not be described, but can be to allow a profile to be defined.

Conditions: opd-1

Cardinality: 0..*

OperationDefinition.overload

Define overloaded variants for when generating code

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

Comments: The combinations are suggestions as to which sets of parameters to use together, but the combinations are not intended to be authoritative.

Cardinality: 0..*

Type: BackboneElement

OperationDefinition.overload.parameterName

Name of parameter to include in overload

Definition: Name of parameter to include in overload.

Cardinality: 0..*

Type: string

OperationDefinition.overload.comment

Comments to go on overload

Definition: Comments to go on overload.

Cardinality: 0..1

Type: string