Skip to main content

OperationDefinition

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

Properties

NameCardTypeDescription
id0..1stringLogical id of this artifact
meta0..1MetaMetadata about the resource
implicitRules0..1uriA set of rules under which this content was created
language0..1codeLanguage of the resource content
text0..1NarrativeText summary of the resource, for human interpretation
contained0..*ResourceContained, inline Resources
extension0..*ExtensionAdditional content defined by implementations
modifierExtension0..*ExtensionExtensions that cannot be ignored
url0..1uriCanonical identifier for this operation definition, represented as a URI (globally unique)
version0..1stringBusiness version of the operation definition
name1..1stringName for this operation definition (computer friendly)
title0..1stringName for this operation definition (human friendly)
status1..1codedraft | active | retired | unknown
kind1..1codeoperation | query
experimental0..1booleanFor testing purposes, not real usage
date0..1dateTimeDate last changed
publisher0..1stringName of the publisher (organization or individual)
contact0..*ContactDetailContact details for the publisher
description0..1markdownNatural language description of the operation definition
useContext0..*UsageContextThe context that the content is intended to support
jurisdiction0..*CodeableConceptIntended jurisdiction for operation definition (if applicable)
purpose0..1markdownWhy this operation definition is defined
affectsState0..1booleanWhether content is changed by the operation
code1..1codeName used to invoke the operation
comment0..1markdownAdditional information about use
base0..1canonicalMarks this as a profile of the base
resource0..*codeTypes this operation applies to
system1..1booleanInvoke at the system level?
type1..1booleanInvoke at the type level?
instance1..1booleanInvoke on an instance?
inputProfile0..1canonicalValidation information for in parameters
outputProfile0..1canonicalValidation information for out parameters
parameter0..*BackboneElementParameters for the operation/query
overload0..*BackboneElementDefine overloaded variants for when generating code

Search Parameters

NameTypeDescriptionExpression
contexttokenA use context assigned to the operation definitionOperationDefinition.useContext.value
context-quantityquantityA quantity- or range-valued use context assigned to the operation definitionOperationDefinition.useContext.value
context-typetokenA type of use context assigned to the operation definitionOperationDefinition.useContext.code
datedateThe operation definition publication dateOperationDefinition.date
descriptionstringThe description of the operation definitionOperationDefinition.description
jurisdictiontokenIntended jurisdiction for the operation definitionOperationDefinition.jurisdiction
namestringComputationally friendly name of the operation definitionOperationDefinition.name
publisherstringName of the publisher of the operation definitionOperationDefinition.publisher
statustokenThe current status of the operation definitionOperationDefinition.status
titlestringThe human-friendly name of the operation definitionOperationDefinition.title
urluriThe uri that identifies the operation definitionOperationDefinition.url
versiontokenThe business version of the operation definitionOperationDefinition.version
context-type-quantitycompositeA use context type and quantity- or range-based value assigned to the operation definitionOperationDefinition.useContext
context-type-valuecompositeA use context type and value assigned to the operation definitionOperationDefinition.useContext
basereferenceMarks this as a profile of the baseOperationDefinition.base
codetokenName used to invoke the operationOperationDefinition.code
input-profilereferenceValidation information for in parametersOperationDefinition.inputProfile
instancetokenInvoke on an instance?OperationDefinition.instance
kindtokenoperation | queryOperationDefinition.kind
output-profilereferenceValidation information for out parametersOperationDefinition.outputProfile
systemtokenInvoke at the system level?OperationDefinition.system
typetokenInvoke at the type level?OperationDefinition.type