FHIR CI-Build

This is the Continuous Integration Build of FHIR (will be incorrect/inconsistent at times).
See the Directory of published versions icon

FHIR Infrastructure icon Work GroupMaturity Level: N Normative (from v4.0.0)Security Category: Anonymous Compartments: No defined compartments

Detailed Descriptions for the elements in the OperationDefinition resource.

OperationDefinition
Definition

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

Short DisplayDefinition of an operation or a named query
Cardinality0..*
TypeCanonicalResource
Summaryfalse
Invariants
Defined on this element
cnl-0Warning Name should be usable as an identifier for the module by machine processing applications such as code generationname.exists() implies name.matches('^[A-Z]([A-Za-z0-9_]){1,254}$')
opd-5Rule A query operation cannot be defined at the instance level(kind = 'query') implies (instance = false)
opd-6Rule 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-7Rule 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')))
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 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.

Short DisplayCanonical identifier for this operation definition, represented as an absolute URI (globally unique)
Cardinality0..1
Typeuri
Requirements

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

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

Invariants
Defined on this element
cnl-1Warning URL should not contain | or # - these characters make processing canonical references problematicexists() implies matches('^[^|# ]+$')
OperationDefinition.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.

Short DisplayAdditional identifier for the implementation guide (business identifier)
NoteThis is a business identifier, not a resource identifier (see discussion)
Cardinality0..*
TypeIdentifier
Requirements

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

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

Short DisplayBusiness version of the operation definition
NoteThis is a business versionId, not a resource version id (see discussion)
Cardinality0..1
Typestring
Summarytrue
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.

OperationDefinition.versionAlgorithm[x]
Definition

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

Short DisplayHow to compare versions
Cardinality0..1
Terminology BindingVersion Algorithm (Extensible)
Typestring|Coding
[x] NoteSee Choice of Datatypes for further information about how to use [x]
Summarytrue
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.

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.

Short DisplayName for this operation definition (computer friendly)
Cardinality1..1
Typestring
Requirements

Support code generation.

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

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

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

Short DisplayName for this operation definition (human friendly)
Cardinality0..1
Typestring
Summarytrue
Comments

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

OperationDefinition.status
Definition

The current state of this operation definition.

Short Displaydraft | active | retired | unknown
Cardinality1..1
Terminology BindingPublicationStatus (Required)
Typecode
Is Modifiertrue (Reason: This is labeled as "Is Modifier" because applications should not use a retired {{title}} without due consideration)
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.

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

OperationDefinition.kind
Definition

Whether this is an operation or a named query.

Short Displayoperation | query
Cardinality1..1
Terminology BindingOperation Kind (Required)
Typecode
Summarytrue
Comments

Named queries are invoked differently, and have different capabilities.

Invariants
Affect this element
opd-5Rule A query operation cannot be defined at the instance level(kind = 'query') implies (instance = false)
opd-6Rule 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-7Rule 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')))
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 for genuine usage.

Short DisplayFor testing purposes, not real usage
Cardinality0..1
Typeboolean
Meaning if MissingIf absent, this resource is treated as though it is not experimental.
Requirements

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

Summarytrue
Comments

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

OperationDefinition.date
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.

Short DisplayDate last changed
Cardinality0..1
TypedateTime
Alternate NamesRevision Date
Summarytrue
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.

OperationDefinition.publisher
Definition

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

Short DisplayName of the publisher/steward (organization or individual)
Cardinality0..1
Typestring
Requirements

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

Summarytrue
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
Definition

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

Short DisplayContact details for the publisher
Cardinality0..*
TypeContactDetail
Summarytrue
Comments

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

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

OperationDefinition.description
Definition

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

Short DisplayNatural language description of the operation definition
Cardinality0..1
Typemarkdown
Summaryfalse
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).

OperationDefinition.useContext
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.

Short DisplayThe context that the content is intended to support
Cardinality0..*
TypeUsageContext
Requirements

Assist in searching for appropriate content.

Summarytrue
Comments

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

OperationDefinition.jurisdiction
Standards StatusThis element has a standards status of "Deprecated" which is different from the status of the whole resource
Definition

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

Short DisplayIntended jurisdiction for operation definition (if applicable)
Cardinality0..*
Terminology BindingJurisdiction ValueSet (Extensible)
TypeCodeableConcept
Summarytrue
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.)

OperationDefinition.purpose
Definition

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

Short DisplayWhy this operation definition is defined
Cardinality0..1
Typemarkdown
Summaryfalse
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.copyright
Definition

A copyright statement relating to the operation definition and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the operation definition.

Short DisplayUse and/or publishing restrictions
Cardinality0..1
Typemarkdown
Requirements

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

Alternate NamesLicense; Restrictions
Summaryfalse
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 resctricted. (e.g. 'All rights reserved', 'Some rights reserved').

Short DisplayCopyright holder and year(s)
Cardinality0..1
Typestring
Requirements

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

Summaryfalse
Comments

The (c) symbol 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.

OperationDefinition.affectsState
Definition

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

Short DisplayWhether content is changed by the operation
Cardinality0..1
Typeboolean
Summarytrue
Comments

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 the GET method when the operation has affectsState = false and all required parameters for the operation are primitive.

OperationDefinition.code
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.

Short DisplayRecommended name for operation in search url
Cardinality1..1
Typecode
Summarytrue
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 icon for the internal HL7 rules around codes, which are useful additional advice for all implementers

OperationDefinition.comment
Definition

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

Short DisplayAdditional information about use
Cardinality0..1
Typemarkdown
Summaryfalse
OperationDefinition.base
Definition

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

Short DisplayMarks this as a profile of the base
Cardinality0..1
Typecanonical(OperationDefinition)
Summarytrue
Comments

A constrained profile can make optional parameters required or not used, introduce new parameters (required or optional), and clarify documentation.

OperationDefinition.resource
Definition

The types on which this operation can be executed.

Short DisplayTypes this operation applies to
Cardinality0..*
Terminology BindingVersion Independent Resource Types (All) (Required)
Additional BindingsPurpose
All Resource TypesUI Binding
Typecode
Summarytrue
Comments

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

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

Short DisplayInvoke at the system level?
Cardinality1..1
Typeboolean
Summarytrue
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).

Short DisplayInvoke at the type level?
Cardinality1..1
Typeboolean
Summarytrue
OperationDefinition.instance
Definition

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

Short DisplayInvoke on an instance?
Cardinality1..1
Typeboolean
Summarytrue
Invariants
Affect this element
opd-5Rule A query operation cannot be defined at the instance level(kind = 'query') implies (instance = false)
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 as a whole.

Short DisplayValidation information for in parameters
Cardinality0..1
Typecanonical(StructureDefinition)
Summaryfalse
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.

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.

Short DisplayValidation information for out parameters
Cardinality0..1
Typecanonical(StructureDefinition)
Summaryfalse
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.

OperationDefinition.parameter
Definition

The parameters for the operation/query.

Short DisplayParameters for the operation/query
Cardinality0..*
Summaryfalse
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-1Rule Either a type must be provided, or partstype.exists() or part.exists()
opd-2Rule A search type can only be specified for parameters of type stringsearchType.exists() implies type = 'string'
opd-3Rule A targetProfile can only be specified for parameters of type Reference, Canonical, or a ResourcetargetProfile.exists() implies (type = 'Reference' or type = 'canonical' or type.memberOf('http://hl7.org/fhir/ValueSet/resource-types'))
opd-4Rule SearchParamType can only be specified on in parameters(use = 'out') implies searchType.empty()
Affect this element
opd-7Rule 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')))
OperationDefinition.parameter.name
Definition

The name of used to identify the parameter.

Short DisplayName in Parameters.parameter.name or in URL
Cardinality1..1
Typecode
Summaryfalse
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.

Invariants
Affect this element
opd-7Rule 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')))
OperationDefinition.parameter.use
Definition

Whether this is an input or an output parameter.

Short Displayin | out
Cardinality1..1
Terminology BindingOperation Parameter Use (Required)
Typecode
Summaryfalse
Comments

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

Invariants
Affect this element
opd-6Rule 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-7Rule 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')))
opd-4Rule SearchParamType can only be specified on in parameters(use = 'out') implies searchType.empty()
OperationDefinition.parameter.scope
Definition

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

Short Displayinstance | type | system
Cardinality0..*
Terminology BindingOperation Parameter Scope (Required)
Typecode
Meaning if MissingIf no scope is indicated, it is assumed that the parameter is relevant whenever the operation is invoked.
Summaryfalse
OperationDefinition.parameter.min
Definition

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

Short DisplayMinimum Cardinality
Cardinality1..1
Typeinteger
Summaryfalse
OperationDefinition.parameter.max
Definition

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

Short DisplayMaximum Cardinality (a number or *)
Cardinality1..1
Typestring
Summaryfalse
OperationDefinition.parameter.documentation
Definition

Describes the meaning or use of this parameter.

Short DisplayDescription of meaning/use
Cardinality0..1
Typemarkdown
Summaryfalse
OperationDefinition.parameter.type
Definition

The type for this parameter.

Short DisplayWhat type this parameter has
Cardinality0..1
Terminology BindingAll FHIR Types (Required)
Typecode
Summaryfalse
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-7Rule 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')))
opd-1Rule Either a type must be provided, or partstype.exists() or part.exists()
opd-2Rule A search type can only be specified for parameters of type stringsearchType.exists() implies type = 'string'
opd-3Rule A targetProfile can only be specified for parameters of type Reference, Canonical, or a ResourcetargetProfile.exists() implies (type = 'Reference' or type = 'canonical' or type.memberOf('http://hl7.org/fhir/ValueSet/resource-types'))
OperationDefinition.parameter.allowedType
Definition

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

Short DisplayAllowed sub-type this parameter can have (if type is abstract)
Cardinality0..*
Terminology BindingAll FHIR Types (Required)
Typecode
Summaryfalse
Comments

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

OperationDefinition.parameter.targetProfile
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.

Short DisplayIf type is Reference | canonical, allowed targets. If type is 'Resource', then this constrains the allowed resource types
Cardinality0..*
Typecanonical(StructureDefinition)
Summaryfalse
Comments

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

Invariants
Affect this element
opd-3Rule A targetProfile can only be specified for parameters of type Reference, Canonical, or a ResourcetargetProfile.exists() implies (type = 'Reference' or type = 'canonical' or type.memberOf('http://hl7.org/fhir/ValueSet/resource-types'))
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.

Short Displaynumber | date | string | token | reference | composite | quantity | uri | special
Cardinality0..1
Terminology BindingSearchParamType (Required)
Typecode
Summaryfalse
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

Invariants
Affect this element
opd-6Rule 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-2Rule A search type can only be specified for parameters of type stringsearchType.exists() implies type = 'string'
opd-4Rule SearchParamType can only be specified on in parameters(use = 'out') implies searchType.empty()
OperationDefinition.parameter.binding
Definition

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

Short DisplayValueSet details if this is coded
Cardinality0..1
Summaryfalse
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.

Short Displayrequired | extensible | preferred | example
Cardinality1..1
Terminology BindingBindingStrength (Required)
Typecode
Alternate Namesconformance; extensibility
Summaryfalse
Comments

For further discussion, see Using Terminologies.

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.

Short DisplaySource of value set
Cardinality1..1
Typecanonical(ValueSet)
Summaryfalse
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
Definition

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

Short DisplayReferences to this parameter
Cardinality0..*
Summaryfalse
Comments

Resolution applies if the referenced parameter exists.

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.

Short DisplayReferencing parameter
Cardinality1..1
Typestring
Summaryfalse
OperationDefinition.parameter.referencedFrom.sourceId
Definition

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

Short DisplayElement id of reference
Cardinality0..1
Typestring
Summaryfalse
OperationDefinition.parameter.part
Definition

The parts of a nested Parameter.

Short DisplayParts of a nested Parameter
Cardinality0..*
TypeSee OperationDefinition.parameter
Summaryfalse
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-1Rule Either a type must be provided, or partstype.exists() or part.exists()
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.

Short DisplayDefine overloaded variants for when generating code
Cardinality0..*
Summaryfalse
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
Definition

Name of parameter to include in overload.

Short DisplayName of parameter to include in overload
Cardinality0..*
Typestring
Summaryfalse
OperationDefinition.overload.comment
Definition

Comments to go on overload.

Short DisplayComments to go on overload
Cardinality0..1
Typestring
Summaryfalse