DSTU2

This page is part of the FHIR Specification (v1.0.2: DSTU 2). The current version which supercedes this version is 4.3.0. For a full list of available versions, see the Directory of published versions

6.18.6 Resource OperationDefinition - Detailed Descriptions

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

Control1..1
OperationDefinition.url
Definition

An absolute URL that is used to identify this operation definition when it is referenced in a specification, model, design or an instance. This SHALL be a URL, SHOULD be globally unique, and SHOULD be an address at which this operation definition is (or will be) published.

Control0..1
Typeuri
Comments

Can be a urn:uuid: or a urn:oid:.

OperationDefinition.version
Definition

The identifier that is used to identify this version of the profile when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the profile author manually and the value should be a timestamp.

NoteThis is a business versionId, not a resource identifier (see discussion)
Control0..1
Typestring
Requirements

There may be multiple resource versions of the profile that have this same identifier. The resource version id will change for technical reasons, whereas the stated version number needs to be under the author's control.

OperationDefinition.name
Definition

A free text natural language name identifying the operation.

Control1..1
Typestring
Comments

Not expected to be globally unique.

OperationDefinition.status
Definition

The status of the profile.

Control1..1
BindingConformanceResourceStatus: The lifecycle status of a Value Set or Concept Map. (Required)
Typecode
Is Modifiertrue
Requirements

Allows filtering of profiles that are appropriate for use vs. not.

OperationDefinition.kind
Definition

Whether this is an operation or a named query.

Control1..1
BindingOperationKind: Whether an operation is a normal operation or a query. (Required)
Typecode
Comments

Named queries are invoked differently, and have different capabilities.

OperationDefinition.experimental
Definition

This profile was authored for testing purposes (or education/evaluation/marketing), and is not intended to be used for genuine usage.

Control0..1
Typeboolean
Requirements

Allows filtering of profiles that are appropriate for use vs. not.

OperationDefinition.publisher
Definition

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

Control0..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. This item SHOULD be populated unless the information is available from context.

OperationDefinition.contact
Definition

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

Control0..*
Summarytrue
Comments

May be a web site, an email address, a telephone number (tel:), etc.

OperationDefinition.contact.name
Definition

The name of an individual to contact regarding the operation definition.

Control0..1
Typestring
Summarytrue
Comments

If there is no named individual, the telecom is for the organization as a whole.

OperationDefinition.contact.telecom
Definition

Contact details for individual (if a name was provided) or the publisher.

Control0..*
TypeContactPoint
Summarytrue
OperationDefinition.date
Definition

The date this version of the operation definition was published. The date must change when the business version changes, if it does, and it must change if the status code changes. In addition, it should change when the substantive content of the Operation Definition changes.

Control0..1
TypedateTime
Comments

Additional specific dates may be added as extensions.

OperationDefinition.description
Definition

A free text natural language description of the profile and its use.

Control0..1
Typestring
Comments

This field can be used for things such as why the profile was written, comments about misuse, instructions for clinical use and interpretation, literature references, examples from the paper world, etc. It is not a rendering of the profile as conveyed in Profile.text. This item SHOULD be populated unless the information is available from context.

OperationDefinition.requirements
Definition

Explains why this operation definition is needed and why it's been constrained as it has.

Control0..1
Typestring
Comments

This element does not describe the usage of the operation definition (that's done in comments), rather it's for traceability of why the element is either needed or why the constraints exist as they do. This may be used to point to source materials or specifications that drove the structure of this data element.

OperationDefinition.idempotent
Definition

Operations that are idempotent (see HTTP specification definition of idempotent ) may be invoked by performing an HTTP GET operation instead of a POST.

Control0..1
Typeboolean
OperationDefinition.code
Definition

The name used to invoke the operation.

Control1..1
Typecode
OperationDefinition.notes
Definition

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

Control0..1
Typestring
OperationDefinition.base
Definition

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

Control0..1
TypeReference(OperationDefinition)
Comments

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

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

Control1..1
Typeboolean
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 resource type for the context).

Control0..*
BindingResourceType: Any defined Resource Type name
Typecode
OperationDefinition.instance
Definition

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

Control1..1
Typeboolean
OperationDefinition.parameter
Definition

The parameters for the operation/query.

Control0..*
Comments

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

InvariantsDefined on this element
opd-1: Either a type must be provided, or parts (xpath: exists(f:type) or exists(f:part))
OperationDefinition.parameter.name
Definition

The name of used to identify the parameter.

Control1..1
Typecode
Comments

This name must be a token (start with a letter in a..z, and only contain letters, numerals, and underscore.

OperationDefinition.parameter.use
Definition

Whether this is an input or an output parameter.

Control1..1
BindingOperationParameterUse: Whether an operation parameter is an input or an output parameter. (Required)
Typecode
Comments

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

OperationDefinition.parameter.min
Definition

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

Control1..1
Typeinteger
OperationDefinition.parameter.max
Definition

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

Control1..1
Typestring
OperationDefinition.parameter.documentation
Definition

Describes the meaning or use of this parameter.

Control0..1
Typestring
OperationDefinition.parameter.type
Definition

The type for this parameter.

Control0..1
BindingParameter Types used in Operation Definitions: The type of a parameter. (Required)
Typecode
Comments

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

InvariantsAffect this element
opd-1: Either a type must be provided, or parts (xpath: exists(f:type) or exists(f:part))
OperationDefinition.parameter.profile
Definition

A profile the specifies the rules that this parameter must conform to.

Control0..1
TypeReference(StructureDefinition)
OperationDefinition.parameter.binding
Definition

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

Control0..1
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.

Control1..1
BindingBindingStrength: Indication of the degree of conformance expectations associated with a binding. (Required)
Typecode
Alternate Namesconformance; extensibility
Comments

For further discussion, see Using Terminologies.

OperationDefinition.parameter.binding.valueSet[x]
Definition

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

Control1..1
Typeuri|Reference(ValueSet)
[x] NoteSee 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.part
Definition

The parts of a Tuple Parameter.

Control0..*
TypeSee OperationDefinition.parameter
Comments

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

InvariantsAffect this element
opd-1: Either a type must be provided, or parts (xpath: exists(f:type) or exists(f:part))