R4 Ballot #1 (Mixed Normative/Trial use) Current Build
This page was published as part of FHIR v3.3.0: R4 Ballot #1 : Mixed Normative/Trial use (First Normative ballot). It has been superceded by R4 . For a full list of available versions, see the Directory of published versions .
FHIR Infrastructure Work Group Maturity Level : 4 N   Normative (from v4.1.0) Security Category : Anonymous Compartments : Not linked to any defined compartments

Detailed Descriptions for the elements in the OperationDefinition resource.

Standards Status This element has a standards status of "Trial Use" which is different to the status of the whole resource Comments The code does not include the '$' prefix that is always included in the URL when the operation is invoked.
OperationDefinition
Element Id OperationDefinition
Definition

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

Control Cardinality 1..1 0..*
Type DomainResource
Invariants
Defined on this element
opd-0 Warning Name should be usable as an identifier for the module by machine processing applications such as code generation name.matches('[A-Z]([A-Za-z0-9_]){0,254}')
OperationDefinition.url
Element Id OperationDefinition.url
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 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.

Control Cardinality 0..1
Type uri
Requirements

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

Summary true
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 URL SHOULD include the major determination of when to create a new version of a resource (same url, new version) vs. defining a new artifact is up to the operation definition. For more information see 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.

OperationDefinition.version
Element Id OperationDefinition.version
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.

Note This is a business versionId, not a resource version id (see discussion )
Control Cardinality 0..1
Type string
Summary true
Comments

There may be different operation definition instances that have the same identifier 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 [url]|[version].

OperationDefinition.name
Element Id OperationDefinition.name
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.

Control Cardinality 1..1
Type string
Requirements

Support human navigation and code generation.

Summary true
Comments

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

Invariants
Affect this element
inv-0 Warning Name should be usable as an identifier for the module by machine processing applications such as code generation name.matches('[A-Z]([A-Za-z0-9_]){0,254}')
OperationDefinition.title
Element Id OperationDefinition.title
Definition

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

Cardinality 0..1
Type string
Summary true
Comments

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

OperationDefinition.status
Element Id OperationDefinition.status
Definition

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

Control Cardinality 1..1
Terminology Binding PublicationStatus ( Required )
Type code
Is Modifier true (Reason: null) This is labeled as "Is Modifier" because applications should not use a retired {{title}} without due consideration)
Summary true
Comments

Allows filtering of operation definitions that are appropriate for use versus not.

OperationDefinition.kind
Element Id OperationDefinition.kind
Definition

Whether this is an operation or a named query.

Control Cardinality 1..1
Terminology Binding OperationKind ( Required )
Type code
Summary true
Comments

Named queries are invoked differently, and have different capabilities.

OperationDefinition.experimental
Element Id OperationDefinition.experimental
Definition

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.

Control Cardinality 0..1
Type boolean
Is Modifier true (Reason: null) Requirements

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

Summary true
Comments

Allows filtering of operation definitions that are appropriate for use versus not.

OperationDefinition.date
Element Id OperationDefinition.date
Definition

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.

Control Cardinality 0..1
Type dateTime
Alternate Names Revision Date
Summary true
Comments

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.

OperationDefinition.publisher
Element Id OperationDefinition.publisher
Definition

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

Control Cardinality 0..1
Type string
Requirements

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

Summary true
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.

OperationDefinition.contact
Element Id OperationDefinition.contact
Definition

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

Control Cardinality 0..*
Type ContactDetail
Summary true
Comments

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

OperationDefinition.description
Element Id OperationDefinition.description
Definition

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

Control Cardinality 0..1
Type markdown
Comments

This description can be used to capture details such as why the operation definition was built, 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 profile operation definition is presumed to be the predominant language in the place the profile operation definition was created).

OperationDefinition.useContext
Element Id OperationDefinition.useContext
Definition

The content was developed with a focus and intent of supporting the contexts that are listed. These terms 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.

Control Cardinality 0..*
Type UsageContext
Requirements

Assist in searching for appropriate content.

Summary true
Comments

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

OperationDefinition.jurisdiction
Element Id OperationDefinition.jurisdiction
Definition

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

Control Cardinality 0..*
Terminology Binding Jurisdiction ValueSet ( Extensible )
Type CodeableConcept
Summary true
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.

OperationDefinition.purpose
Element Id OperationDefinition.purpose
Definition

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

Control Cardinality 0..1
Type markdown
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.

OperationDefinition.affectsState
Element Id OperationDefinition.affectsState
Definition

Operations that have affects state = false (see HTTP specification definition of idempotent ) may be invoked by performing an HTTP GET Whether the operation instead of a POST. affects state. Side effects such as producing audit trail entries do not count as 'affecting state'.

Control Cardinality 0..1
Type boolean
Summary true
Comments

Side effects such as producing audit trail entries do not count as 'changing state/content'. What http methods can be used for the operation depends on the .affectsState value and whether the input parameters are primitive or complex:

  1. Servers SHALL support POST method for all operations.

  2. Servers SHALL support GET method if all the parameters for the operation are primitive or there are no parameters and the operation has affectsState = false.

OperationDefinition.code
Element Id OperationDefinition.code
Definition

The name used to invoke the operation.

Control Cardinality 1..1
Type code
Summary true
OperationDefinition.comment
Element Id OperationDefinition.comment
Definition

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

Control Cardinality 0..1
Type markdown
OperationDefinition.base
Element Id OperationDefinition.base
Definition

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

Control Cardinality 0..1
Type canonical ( OperationDefinition )
Summary true
Comments

A constrained profile can make optional parameters required or not used and clarify documentation.

OperationDefinition.resource
Element Id OperationDefinition.resource
Definition

The types on which this operation can be executed.

Control Cardinality 0..*
Terminology Binding Any defined Resource Type name
Type code
Summary true
Comments

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

OperationDefinition.system
Element Id OperationDefinition.system
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).

Control Cardinality 1..1
Type boolean
Summary true
OperationDefinition.type
Element Id OperationDefinition.type
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).

Control Cardinality 1..1
Type boolean
Summary true
OperationDefinition.instance
Element Id OperationDefinition.instance
Definition

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

Control Cardinality 1..1
Type boolean
Summary true
OperationDefinition.inputProfile
Element Id OperationDefinition.inputProfile
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. resource as a whole.

Control Cardinality 0..1
Type canonical ( StructureDefinition )
Comments

If present the profile shall not conflict with conflict with what is specified in the parameters in the operation definition (max/min etc.). 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.

OperationDefinition.outputProfile
Element Id OperationDefinition.outputProfile
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.

Control Cardinality 0..1
Type canonical ( StructureDefinition )
Comments

If present the profile shall not conflict with conflict with what is specified in the parameters in the operation definition (max/min etc.). 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.

OperationDefinition.parameter
Element Id OperationDefinition.parameter
Definition

The parameters for the operation/query.

Control Cardinality 0..*
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.

Invariants
Defined on this element
opd-1 : Rule Either a type must be provided, or parts ( expression : type.exists() or part.exists(), xpath: exists(f:type) or exists(f:part)) part.exists()
opd-2 : Rule A search type can only be specified for parameters of type string ( expression : searchType.exists() implies type = 'string', xpath: not(exists(f:searchType)) 'string'
opd-3 Rule A targetProfile can only be specified for parameters of type Reference or (f:type/@value Canonical targetProfile.exists() implies (type = 'string')) 'Reference' or type = 'canonical')
OperationDefinition.parameter.name
Element Id OperationDefinition.parameter.name
Definition

The name of used to identify the parameter.

Control Cardinality 1..1
Type code
Comments

This name must be a token (start with a letter in a..z, 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.

OperationDefinition.parameter.use
Element Id OperationDefinition.parameter.use
Definition

Whether this is an input or an output parameter.

Control Cardinality 1..1
Terminology Binding OperationParameterUse ( Required )
Type code
Comments

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

OperationDefinition.parameter.min
Element Id OperationDefinition.parameter.min
Definition

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

Control Cardinality 1..1
Type integer
OperationDefinition.parameter.max
Element Id OperationDefinition.parameter.max
Definition

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

Control Cardinality 1..1
Type string
OperationDefinition.parameter.documentation
Element Id OperationDefinition.parameter.documentation
Definition

Describes the meaning or use of this parameter.

Control Cardinality 0..1
Type string
OperationDefinition.parameter.type
Element Id OperationDefinition.parameter.type
Definition

The type for this parameter.

Control Cardinality 0..1
Terminology Binding Any defined Resource or Data Type name (including "Any" and "Type")
Type code
Comments

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

Invariants
Affect this element
opd-1 : Rule Either a type must be provided, or parts ( expression : type.exists() or part.exists(), xpath: exists(f:type) or exists(f:part)) part.exists()
OperationDefinition.parameter.targetProfile
Element Id OperationDefinition.parameter.targetProfile
Definition

If Used when the type is "Reference", then targetProfile lists "Reference" or "canonical", and identifies a one profile structure or more profiles implementation Guide that applies to the Reference can refer 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.

Control Cardinality 0..*
Type canonical ( StructureDefinition )
Comments

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

OperationDefinition.parameter.searchType
Element Id OperationDefinition.parameter.searchType
Definition

How the parameter is understood as a search parameter. This is only used if the parameter type is 'string'.

Control Cardinality 0..1
Terminology Binding SearchParamType ( Required )
Type code
Invariants
Affect this element
opd-2 : Rule A search type can only be specified for parameters of type string ( expression : searchType.exists() implies type = 'string', xpath: not(exists(f:searchType)) or (f:type/@value = 'string')) 'string'
OperationDefinition.parameter.binding
Element Id OperationDefinition.parameter.binding
Definition

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

Control Cardinality 0..1
OperationDefinition.parameter.binding.strength
Element Id OperationDefinition.parameter.binding.strength
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.

Control Cardinality 1..1
Terminology Binding BindingStrength ( Required )
Type code
Alternate Names conformance; extensibility
Comments

For further discussion, see Using Terminologies .

OperationDefinition.parameter.binding.valueSet[x] OperationDefinition.parameter.binding.valueSet
Element Id OperationDefinition.parameter.binding.valueSet[x] OperationDefinition.parameter.binding.valueSet
Definition

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

Control Cardinality 1..1
Type uri | canonical ( ValueSet )
[x] Note See Choice of Data Types for further information about how to use [x] Comments

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

OperationDefinition.parameter.referencedFrom
Element Id OperationDefinition.parameter.referencedFrom
Definition

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

Cardinality 0..*
Comments

Resolution applies if the referenced parameter exists.

OperationDefinition.parameter.referencedFrom.source
Element Id OperationDefinition.parameter.referencedFrom.source
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 OperationDefinition.parameter.referencedFrom.sourceId
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
Element Id OperationDefinition.parameter.part
Definition

The parts of a nested Parameter.

Control Cardinality 0..*
Type See OperationDefinition.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.

Invariants
Affect this element
opd-1 : Rule Either a type must be provided, or parts ( expression : type.exists() or part.exists(), xpath: exists(f:type) or exists(f:part)) part.exists()
OperationDefinition.overload
Element Id OperationDefinition.overload
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.

Control Cardinality 0..*
Comments

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

OperationDefinition.overload.parameterName
Element Id OperationDefinition.overload.parameterName
Definition

Name of parameter to include in overload.

Control Cardinality 0..*
Type string
OperationDefinition.overload.comment
Element Id OperationDefinition.overload.comment
Definition

Comments to go on overload.

Control Cardinality 0..1
Type string