Release 4B 5

This page is part of the FHIR Specification (v4.3.0: R4B (v5.0.0: R5 - STU ). The This is the current published version which supercedes in it's permanent home (it will always be available at this version is 5.0.0 . URL). For a full list of available versions, see the Directory of published versions . Page versions: R5 R4B R5 R4B R4 R3 R2

5.4 5.5 Resource OperationDefinition - Content

FHIR Infrastructure icon Work Group Maturity Level : N   Normative (from v4.0.0) Security Category : Anonymous Compartments : Not linked to any No defined compartments
This page has been approved as part of an ANSI standard. See the Conformance Package for further details.

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

5.4.1 5.5.1 Scope and Usage

The OperationDefinition resource provides a formal computable definition of an operation or a named query . The OperationDefinition serves two principal purposes:

  • To allow for automatic determination of system compatibility
  • To allow for dynamic generation of forms to drive the operations

See below for further information about these, and about how operations and named queries are executed.

5.4.2 5.5.2 Boundaries and Relationships

OperationDefinitions are published to define operations that servers can implement in a common fashion. The FHIR specification itself describes some (see below), and other organizations (including IHE, national programs, jurisdictions and vendors) are able to publish additional OperationDefinitions.

OperationDefinition resources are referred to from two different places:

  • From a CapabilityStatement , to declare what operations a system does or should implement
  • From another OperationDefinition resource. This allows for a server to describe a limited implementation of a standard operation, or to allow traceability if the server has to rename the operation due to a name clash

OperationDefinitions can be used to define a custom query (kind = query, discussed below) which functions as a special kind of search. This is different to a SearchParameter because a custom query may define multiple parameters and can define of complex search behavior beyond what SearchParameter can specify. It also typically overrides the behavior of the query functionality, while search parameters can only act as additional filters.

5.4.3 5.5.3 References to this Resource

This resource is referenced by

5.4.4 5.5.4 Resource Content

Structure

Name Flags Card. Type Description & Constraints doco
. . OperationDefinition N DomainResource Definition of an operation or a named query
+ Warning: Name should be usable as an identifier for the module by machine processing applications such as code generation
+ Rule: A query operation cannot be defined at the instance level
+ Rule: A query operation requires input parameters to have a search type
+ Rule: Named queries always have a single output parameter named 'result' of type Bundle

Elements defined in Ancestors: id , meta , implicitRules , language , text , contained , extension , modifierExtension
Interfaces Implemented: CanonicalResource
. . . url Σ C 0..1 uri Canonical identifier for this operation definition, represented as a an absolute URI (globally unique)
+ Warning: URL should not contain | or # - these characters make processing canonical references problematic
. . version . identifier Σ TU 0..1 0..* Identifier Additional identifier for the implementation guide (business identifier)

... version Σ 0..1 string Business version of the operation definition
. . . versionAlgorithm[x] Σ TU 0..1 How to compare versions
Binding: Version Algorithm ( Extensible )
.... versionAlgorithmString string
.... versionAlgorithmCoding Coding
. . . name Σ C 1..1 string Name for this operation definition (computer friendly)
. . . title Σ T 0..1 string Name for this operation definition (human friendly)
. . . status ?! Σ 1..1 code draft | active | retired | unknown
Binding: PublicationStatus ( Required )
. . . kind Σ C 1..1 code operation | query
Binding: OperationKind Operation Kind ( Required )
. . . experimental Σ 0..1 boolean For testing purposes, not real usage
. . . date Σ 0..1 dateTime Date last changed
. . . publisher Σ T 0..1 string Name of the publisher publisher/steward (organization or individual)
. . . contact Σ 0..* ContactDetail Contact details for the publisher

. . . description T 0..1 markdown Natural language description of the operation definition
. . . useContext Σ TU 0..* UsageContext The context that the content is intended to support

. . . jurisdiction Σ XD 0..* CodeableConcept Intended jurisdiction for operation definition (if applicable)
Binding: Jurisdiction ValueSet ( Extensible )

. . . purpose T 0..1 markdown Why this operation definition is defined
. . . copyright T TU 0..1 markdown Use and/or publishing restrictions
... copyrightLabel T TU 0..1 string Copyright holder and year(s)
... affectsState Σ 0..1 boolean Whether content is changed by the operation
. . . code Σ 1..1 code Name used to invoke the Recommended name for operation in search url
. . . comment 0..1 markdown Additional information about use
. . . base Σ 0..1 canonical ( OperationDefinition ) Marks this as a profile of the base
. . . resource Σ 0..* code Types this operation applies to
ResourceType Binding: Version Independent Resource Types (All) ( Required )
Additional Bindings Purpose
All Resource Types UI Binding


. . . system Σ 1..1 boolean Invoke at the system level?
. . . type Σ 1..1 boolean Invoke at the type level?
. . . instance Σ C 1..1 boolean Invoke on an instance?
. . . inputProfile 0..1 canonical ( StructureDefinition ) Validation information for in parameters
. . . outputProfile 0..1 canonical ( StructureDefinition ) Validation information for out parameters
. . . parameter I C 0..* BackboneElement Parameters for the operation/query
+ Rule: Either a type must be provided, or parts
+ Rule: A search type can only be specified for parameters of type string
+ Rule: A targetProfile can only be specified for parameters of type Reference Reference, Canonical, or Canonical a Resource
+ Rule: SearchParamType can only be specified on in parameters

. . . . name C 1..1 code Name in Parameters.parameter.name or in URL
. . . . use C 1..1 code in | out
Binding: OperationParameterUse Operation Parameter Use ( Required )
. . . . min scope TU 1..1 0..* integer code Minimum Cardinality instance | type | system
Binding: Operation Parameter Scope ( Required )

. . . . max min 1..1 integer Minimum Cardinality
.... max 1..1 string Maximum Cardinality (a number or *)
. . . . documentation T 0..1 markdown Description of meaning/use
. . . . documentation type C 0..1 string code Description of meaning/use What type this parameter has
Binding: All FHIR Types ( Required )
. . . . type allowedType I TU 0..1 0..* code What type Allowed sub-type this parameter has can have (if type is abstract)
FHIRAllTypes Binding: All FHIR Types ( Required )

. . . . targetProfile C 0..* canonical ( StructureDefinition ) If type is Reference | canonical, allowed targets targets. If type is 'Resource', then this constrains the allowed resource types

. . . . searchType I C 0..1 code number | date | string | token | reference | composite | quantity | uri | special
Binding: SearchParamType ( Required )
. . . . binding 0..1 BackboneElement ValueSet details if this is coded
. . . . . strength 1..1 code required | extensible | preferred | example
Binding: BindingStrength ( Required )
. . . . . valueSet 1..1 canonical ( ValueSet ) Source of value set
. . . . referencedFrom TU 0..* BackboneElement References to this parameter

. . . . . source 1..1 string Referencing parameter
. . . . . sourceId 0..1 string Element id of reference
. . . . part I C 0..* see parameter Parts of a nested Parameter

. . . overload 0..* BackboneElement Define overloaded variants for when generating code

. . . . parameterName 0..* string Name of parameter to include in overload

. . . . comment 0..1 string Comments to go on overload

doco Documentation for this format icon

See the Extensions for this resource

UML Diagram ( Legend )

OperationDefinition ( DomainResource ) + CanonicalResource 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 url : uri [0..1] 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 identifier : Identifier [0..*] 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 version : string [0..1] Indicates the mechanism used to compare versions to determine which is more current versionAlgorithm[x] : DataType [0..1] « string | Coding ; null (Strength=Extensible) VersionAlgorithm + » 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 name : string [1..1] « This element has or is affected by some invariants C » A short, descriptive, user-friendly title for the operation definition title : string [0..1] The status current state of this operation definition. Enables tracking the life-cycle of the content definition (this element modifies the meaning of other elements) status : code [1..1] « null (Strength=Required) PublicationStatus ! » Whether this is an operation or a named query kind : code [1..1] « null (Strength=Required) OperationKind ! » « This element has or is affected by some invariants C » 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 experimental : boolean [0..1] The date (and optionally time) when the operation definition was published. 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 date : dateTime [0..1] The name of the organization or individual that published responsible for the release and ongoing maintenance of the operation definition publisher : string [0..1] Contact details to assist a user in finding and communicating with the publisher contact : ContactDetail [0..*] A free text natural language description of the operation definition from a consumer's perspective description : markdown [0..1] 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 instances useContext : UsageContext [0..*] A legal or geographic region in which the operation definition is intended to be used jurisdiction : CodeableConcept [0..*] « null (Strength=Extensible) Jurisdiction ValueSet JurisdictionValueSet + » Explanation of why this operation definition is needed and why it has been designed as it has purpose : markdown [0..1] 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 copyright : markdown [0..1] 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') copyrightLabel : string [0..1] Whether the operation affects state. Side effects such as producing audit trail entries do not count as 'affecting state' affectsState : boolean [0..1] The name label that is recommended to be used in the URL for this operation. In some cases, servers may need to invoke use a different CapabilityStatement operation.name to differentiate between multiple SearchParameters that happen to have the operation same code code : code [1..1] Additional information about how to use this operation or named query comment : markdown [0..1] Indicates that this operation definition is a constraining profile on the base base : canonical [0..1] « OperationDefinition » The types on which this operation can be executed resource : code [0..*] « null (Strength=Required) ResourceType VersionIndependentResourceTyp... ! » 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) system : boolean [1..1] 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) type : boolean [1..1] Indicates whether this operation can be invoked on a particular instance of one of the given types instance : boolean [1..1] « This element has or is affected by some invariants C » 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 inputProfile : canonical [0..1] « StructureDefinition » Additional validation information for the out parameters - a single profile that covers all the parameters. The profile is a constraint on the parameters resource outputProfile : canonical [0..1] « StructureDefinition » Parameter The name of used to identify the parameter name : code [1..1] « This element has or is affected by some invariants C » Whether this is an input or an output parameter use : code [1..1] « null (Strength=Required) OperationParameterUse ! » « This element has or is affected by some invariants C » If present, indicates that the parameter applies when the operation is being invoked at the specified level scope : code [0..*] « null (Strength=Required) OperationParameterScope ! » The minimum number of times this parameter SHALL appear in the request or response min : integer [1..1] The maximum number of times this element is permitted to appear in the request or response max : string [1..1] Describes the meaning or use of this parameter documentation : string markdown [0..1] The type for this parameter type : code [0..1] « null (Strength=Required) FHIRAllTypes FHIRTypes ! » « This element has or is affected by some invariants C » Support for polymorphic types. If the parameter type is abstract, this element lists allowed sub-types for the parameter allowedType : code [0..*] « null (Strength=Required) FHIRTypes ! » 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 targetProfile : canonical [0..*] « StructureDefinition » « This element has or is affected by some invariants C » How the parameter is understood if/when it used as a search parameter. This is only used if the parameter type is 'string' a string searchType : code [0..1] « null (Strength=Required) SearchParamType ! » « This element has or is affected by some invariants C » Binding 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 strength : code [1..1] « null (Strength=Required) BindingStrength ! » Points to the value set or external definition (e.g. implicit value set) that identifies the set of codes to be used valueSet : canonical [1..1] « ValueSet » ReferencedFrom 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 source : string [1..1] The id of the element in the referencing resource that is expected to resolve to this resource sourceId : string [0..1] Overload Name of parameter to include in overload parameterName : string [0..*] Comments to go on overload comment : string [0..1] Binds to a value set if this parameter is coded (code, Coding, CodeableConcept) binding [0..1] Identifies other resource parameters within the operation invocation that are expected to resolve to this resource referencedFrom [0..*] The parts of a nested Parameter part [0..*] The parameters for the operation/query parameter [0..*] Defines an appropriate combination of parameters to use when invoking this operation, to help code generators when generating overloaded parameter sets for this operation overload [0..*]

XML Template 

<OperationDefinition xmlns="http://hl7.org/fhir"> doco
 <!-- from Resource: id, meta, implicitRules, and language -->
 <!-- from DomainResource: text, contained, extension, and modifierExtension -->
 <

 <url value="[uri]"/><!-- 0..1 Canonical identifier for this operation definition, represented as an absolute URI (globally unique) -->
 <identifier><!-- 0..* Identifier Additional identifier for the implementation guide (business identifier) --></identifier>

 <version value="[string]"/><!-- 0..1 Business version of the operation definition -->
 <

 <versionAlgorithm[x]><!-- 0..1 string|Coding How to compare versions --></versionAlgorithm[x]>
 <name value="[string]"/><!-- I 1..1 Name for this operation definition (computer friendly) -->

 <title value="[string]"/><!-- 0..1 Name for this operation definition (human friendly) -->
 <
 <
 <
 <
 <

 <status value="[code]"/><!-- 1..1 draft | active | retired | unknown -->
 <kind value="[code]"/><!-- I 1..1 operation | query -->
 <experimental value="[boolean]"/><!-- 0..1 For testing purposes, not real usage -->
 <date value="[dateTime]"/><!-- 0..1 Date last changed -->
 <publisher value="[string]"/><!-- 0..1 Name of the publisher/steward (organization or individual) -->

 <contact><!-- 0..* ContactDetail Contact details for the publisher --></contact>
 <description value="[markdown]"/><!-- 0..1 Natural language description of the operation definition -->
 <</useContext>

 <useContext><!-- 0..* UsageContext The context that the content is intended to support --></useContext>

 <jurisdiction><!-- 0..* CodeableConcept Intended jurisdiction for operation definition (if applicable) --></jurisdiction>
 <purpose value="[markdown]"/><!-- 0..1 Why this operation definition is defined -->
 <copyright value="[markdown]"/><!-- 0..1 Use and/or publishing restrictions -->
 <copyrightLabel value="[string]"/><!-- 0..1 Copyright holder and year(s) -->

 <affectsState value="[boolean]"/><!-- 0..1 Whether content is changed by the operation -->
 <

 <code value="[code]"/><!-- 1..1 Recommended name for operation in search url -->

 <comment value="[markdown]"/><!-- 0..1 Additional information about use -->
 <base><!-- 0..1 canonical(OperationDefinition) Marks this as a profile of the base --></base>
 <

 <resource value="[code]"/><!-- 0..* Types this operation applies to -->

 <system value="[boolean]"/><!-- 1..1 Invoke at the system level? -->
 <type value="[boolean]"/><!-- 1..1 Invoke at the type level? -->
 <

 <instance value="[boolean]"/><!-- I 1..1 Invoke on an instance? -->

 <inputProfile><!-- 0..1 canonical(StructureDefinition) Validation information for in parameters --></inputProfile>
 <outputProfile><!-- 0..1 canonical(StructureDefinition) Validation information for out parameters --></outputProfile>
 <
  <
  <

 <parameter>  <!-- I 0..* Parameters for the operation/query -->
  <name value="[code]"/><!-- I 1..1 Name in Parameters.parameter.name or in URL -->
  <use value="[code]"/><!-- I 1..1 in | out -->
  <scope value="[code]"/><!-- 0..* instance | type | system -->

  <min value="[integer]"/><!-- 1..1 Minimum Cardinality -->
  <max value="[string]"/><!-- 1..1 Maximum Cardinality (a number or *) -->
  <
  <
  <</targetProfile>
  <

  <documentation value="[markdown]"/><!-- 0..1 Description of meaning/use -->
  <type value="[code]"/><!-- I 0..1 What type this parameter has -->
  <allowedType value="[code]"/><!-- 0..* Allowed sub-type this parameter can have (if type is abstract) -->
  <targetProfile><!-- I 0..* canonical(StructureDefinition) If type is Reference | canonical, allowed targets. If type is 'Resource', then this constrains the allowed resource types --></targetProfile>
  <searchType value="[code]"/><!-- I 0..1 number | date | string | token | reference | composite | quantity | uri | special -->

  <binding>  <!-- 0..1 ValueSet details if this is coded -->
   <strength value="[code]"/><!-- 1..1 required | extensible | preferred | example -->
   <valueSet><!-- 1..1 canonical(ValueSet) Source of value set --></valueSet>
  </binding>
  <referencedFrom>  <!-- 0..* References to this parameter -->
   <source value="[string]"/><!-- 1..1 Referencing parameter -->
   <sourceId value="[string]"/><!-- 0..1 Element id of reference -->
  </referencedFrom>
  <</part>

  <part><!-- I 0..* Content as for OperationDefinition.parameter Parts of a nested Parameter --></part>

 </parameter>
 <overload>  <!-- 0..* Define overloaded variants for when  generating code -->
  <parameterName value="[string]"/><!-- 0..* Name of parameter to include in overload -->
  <comment value="[string]"/><!-- 0..1 Comments to go on overload -->
 </overload>
</OperationDefinition>

JSON Template 

{doco
  "resourceType" : "OperationDefinition",
  // from Resource: id, meta, implicitRules, and language
  // from DomainResource: text, contained, extension, and modifierExtension
  "

  "url" : "<uri>", // Canonical identifier for this operation definition, represented as an absolute URI (globally unique)
  "identifier" : [{ Identifier }], // Additional identifier for the implementation guide (business identifier)

  "version" : "<string>", // Business version of the operation definition
  "

  // versionAlgorithm[x]: How to compare versions. One of these 2:
  "versionAlgorithmString" : "<string>",
  "versionAlgorithmCoding" : { Coding },
  "name" : "<string>", // I R!  Name for this operation definition (computer friendly)

  "title" : "<string>", // Name for this operation definition (human friendly)
  "
  "
  "
  "
  "

  "status" : "<code>", // R!  draft | active | retired | unknown
  "kind" : "<code>", // I R!  operation | query
  "experimental" : <boolean>, // For testing purposes, not real usage
  "date" : "<dateTime>", // Date last changed
  "publisher" : "<string>", // Name of the publisher/steward (organization or individual)

  "contact" : [{ ContactDetail }], // Contact details for the publisher
  "description" : "<markdown>", // Natural language description of the operation definition
  "

  "useContext" : [{ UsageContext }], // The context that the content is intended to support

  "jurisdiction" : [{ CodeableConcept }], // Intended jurisdiction for operation definition (if applicable)
  "purpose" : "<markdown>", // Why this operation definition is defined
  "copyright" : "<markdown>", // Use and/or publishing restrictions
  "copyrightLabel" : "<string>", // Copyright holder and year(s)

  "affectsState" : <boolean>, // Whether content is changed by the operation
  "

  "code" : "<code>", // R!  Recommended name for operation in search url

  "comment" : "<markdown>", // Additional information about use
  "
  "

  "base" : "<canonical(OperationDefinition)>", // Marks this as a profile of the base
  "resource" : ["<code>"], // Types this operation applies to

  "system" : <boolean>, // R!  Invoke at the system level?
  "type" : <boolean>, // R!  Invoke at the type level?
  "
  "
  "
  "
    "
    "

  "instance" : <boolean>, // I R!  Invoke on an instance?
  "inputProfile" : "<canonical(StructureDefinition)>", // Validation information for in parameters
  "outputProfile" : "<canonical(StructureDefinition)>", // Validation information for out parameters
  "parameter" : [{ // I Parameters for the operation/query
    "name" : "<code>", // I R!  Name in Parameters.parameter.name or in URL
    "use" : "<code>", // I R!  in | out
    "scope" : ["<code>"], // instance | type | system

    "min" : <integer>, // R!  Minimum Cardinality
    "max" : "<string>", // R!  Maximum Cardinality (a number or *)
    "
    "
    "
    "

    "documentation" : "<markdown>", // Description of meaning/use
    "type" : "<code>", // I What type this parameter has
    "allowedType" : ["<code>"], // Allowed sub-type this parameter can have (if type is abstract)
    "targetProfile" : ["<canonical(StructureDefinition)>"], // I If type is Reference | canonical, allowed targets. If type is 'Resource', then this constrains the allowed resource types
    "searchType" : "<code>", // I number | date | string | token | reference | composite | quantity | uri | special

    "binding" : { // ValueSet details if this is coded
      "strength" : "<code>", // R!  required | extensible | preferred | example
      "

      "valueSet" : "<canonical(ValueSet)>" // R!  Source of value set

    },
    "referencedFrom" : [{ // References to this parameter
      "source" : "<string>", // R!  Referencing parameter
      "sourceId" : "<string>" // Element id of reference
    }],
    "

    "part" : [{ Content as for OperationDefinition.parameter }] // I Parts of a nested Parameter

  }],
  "overload" : [{ // Define overloaded variants for when  generating code
    "parameterName" : ["<string>"], // Name of parameter to include in overload
    "comment" : "<string>" // Comments to go on overload
  }]
}

Turtle Template 

@prefix fhir: <http://hl7.org/fhir/> .doco


[ a fhir:OperationDefinition;
  fhir:nodeRole fhir:treeRoot; # if this is the parser root

  # from Resource: .id, .meta, .implicitRules, and .language
  # from DomainResource: .text, .contained, .extension, and .modifierExtension
  fhir:
  fhir:
  fhir:
  fhir:
  fhir:
  fhir:
  fhir:
  fhir:
  fhir:
  fhir:
  fhir:
  fhir:
  fhir:
  fhir:
  fhir:
  fhir:
  fhir:
  fhir:
  fhir:
  fhir:
  fhir:
  fhir:
  fhir:
  fhir:
  fhir:
    fhir:
    fhir:
    fhir:
    fhir:
    fhir:
    fhir:
    fhir:
    fhir:
    fhir:
      fhir:
      fhir:
    ];
    fhir:
      fhir:
      fhir:
    ], ...;
    fhir:
  ], ...;
  fhir:
    fhir:
    fhir:
  ], ...;

  fhir:url [ uri ] ; # 0..1 Canonical identifier for this operation definition, represented as an absolute URI (globally unique)
  fhir:identifier  ( [ Identifier ] ... ) ; # 0..* Additional identifier for the implementation guide (business identifier)
  fhir:version [ string ] ; # 0..1 Business version of the operation definition
  # versionAlgorithm[x] : 0..1 How to compare versions. One of these 2
    fhir:versionAlgorithm [  a fhir:string ; string ]
    fhir:versionAlgorithm [  a fhir:Coding ; Coding ]
  fhir:name [ string ] ; # 1..1 I Name for this operation definition (computer friendly)
  fhir:title [ string ] ; # 0..1 Name for this operation definition (human friendly)
  fhir:status [ code ] ; # 1..1 draft | active | retired | unknown
  fhir:kind [ code ] ; # 1..1 I operation | query
  fhir:experimental [ boolean ] ; # 0..1 For testing purposes, not real usage
  fhir:date [ dateTime ] ; # 0..1 Date last changed
  fhir:publisher [ string ] ; # 0..1 Name of the publisher/steward (organization or individual)
  fhir:contact  ( [ ContactDetail ] ... ) ; # 0..* Contact details for the publisher
  fhir:description [ markdown ] ; # 0..1 Natural language description of the operation definition
  fhir:useContext  ( [ UsageContext ] ... ) ; # 0..* The context that the content is intended to support
  fhir:jurisdiction  ( [ CodeableConcept ] ... ) ; # 0..* Intended jurisdiction for operation definition (if applicable)
  fhir:purpose [ markdown ] ; # 0..1 Why this operation definition is defined
  fhir:copyright [ markdown ] ; # 0..1 Use and/or publishing restrictions
  fhir:copyrightLabel [ string ] ; # 0..1 Copyright holder and year(s)
  fhir:affectsState [ boolean ] ; # 0..1 Whether content is changed by the operation
  fhir:code [ code ] ; # 1..1 Recommended name for operation in search url
  fhir:comment [ markdown ] ; # 0..1 Additional information about use
  fhir:base [ canonical(OperationDefinition) ] ; # 0..1 Marks this as a profile of the base
  fhir:resource  ( [ code ] ... ) ; # 0..* Types this operation applies to
  fhir:system [ boolean ] ; # 1..1 Invoke at the system level?
  fhir:type [ boolean ] ; # 1..1 Invoke at the type level?
  fhir:instance [ boolean ] ; # 1..1 I Invoke on an instance?
  fhir:inputProfile [ canonical(StructureDefinition) ] ; # 0..1 Validation information for in parameters
  fhir:outputProfile [ canonical(StructureDefinition) ] ; # 0..1 Validation information for out parameters
  fhir:parameter ( [ # 0..* I Parameters for the operation/query
    fhir:name [ code ] ; # 1..1 I Name in Parameters.parameter.name or in URL
    fhir:use [ code ] ; # 1..1 I in | out
    fhir:scope  ( [ code ] ... ) ; # 0..* instance | type | system
    fhir:min [ integer ] ; # 1..1 Minimum Cardinality
    fhir:max [ string ] ; # 1..1 Maximum Cardinality (a number or *)
    fhir:documentation [ markdown ] ; # 0..1 Description of meaning/use
    fhir:type [ code ] ; # 0..1 I What type this parameter has
    fhir:allowedType  ( [ code ] ... ) ; # 0..* Allowed sub-type this parameter can have (if type is abstract)
    fhir:targetProfile  ( [ canonical(StructureDefinition) ] ... ) ; # 0..* I If type is Reference | canonical, allowed targets. If type is 'Resource', then this constrains the allowed resource types
    fhir:searchType [ code ] ; # 0..1 I number | date | string | token | reference | composite | quantity | uri | special
    fhir:binding [ # 0..1 ValueSet details if this is coded
      fhir:strength [ code ] ; # 1..1 required | extensible | preferred | example
      fhir:valueSet [ canonical(ValueSet) ] ; # 1..1 Source of value set
    ] ;
    fhir:referencedFrom ( [ # 0..* References to this parameter
      fhir:source [ string ] ; # 1..1 Referencing parameter
      fhir:sourceId [ string ] ; # 0..1 Element id of reference
    ] ... ) ;
    fhir:part  ( [ See OperationDefinition.parameter ] ... ) ; # 0..* I Parts of a nested Parameter
  ] ... ) ;
  fhir:overload ( [ # 0..* Define overloaded variants for when  generating code
    fhir:parameterName  ( [ string ] ... ) ; # 0..* Name of parameter to include in overload
    fhir:comment [ string ] ; # 0..1 Comments to go on overload
  ] ... ) ;

]

Changes since from both R4 and R4B

OperationDefinition
OperationDefinition.identifier
  • No Changes Added Element
OperationDefinition.versionAlgorithm[x]
  • Added Element
OperationDefinition.copyright
  • Added Element
OperationDefinition.copyrightLabel
  • Added Element
OperationDefinition.resource
  • Change value set from http://hl7.org/fhir/ValueSet/resource-types|4.0.0 to Version Independent Resource Types (All)
  • Add codes ActorDefinition , AdministrableProductDefinition , ArtifactAssessment , BiologicallyDerivedProductDispense , CanonicalResource , Citation , ClinicalUseDefinition , ConditionDefinition , DeviceAssociation , DeviceDispense , DeviceUsage , EncounterHistory , EvidenceReport , FormularyItem , GenomicStudy , ImagingSelection , Ingredient , InventoryItem , InventoryReport , ManufacturedItemDefinition , MedicinalProductDefinition , MetadataResource , NutritionIntake , NutritionProduct , PackagedProductDefinition , Permission , RegulatedAuthorization , RequestOrchestration , Requirements , SubscriptionStatus , SubscriptionTopic , SubstanceDefinition , TestPlan , Transport , BodySite , Conformance , DataElement , DeviceComponent , DeviceUseRequest , DiagnosticOrder , EligibilityRequest , EligibilityResponse , ExpansionProfile , ImagingManifest , ImagingObjectSelection , MedicationOrder , MedicationUsage , Order , OrderResponse , ProcedureRequest , ProcessRequest , ProcessResponse , ReferralRequest , Sequence , ServiceDefinition
OperationDefinition.parameter.scope
  • Added Element
OperationDefinition.parameter.documentation
  • Type changed from string to markdown
OperationDefinition.parameter.type
  • Change value set from http://hl7.org/fhir/ValueSet/all-types|4.0.0 to All FHIR Types
  • Remove codes MoneyQuantity , Population , ProdCharacteristic , SimpleQuantity , SubstanceAmount , CatalogEntry , DeviceUseStatement , DocumentManifest , EffectEvidenceSynthesis , Media , MedicinalProduct , MedicinalProductAuthorization , MedicinalProductContraindication , MedicinalProductIndication , MedicinalProductIngredient , MedicinalProductInteraction , MedicinalProductManufactured , MedicinalProductPackaged , MedicinalProductPharmaceutical , MedicinalProductUndesirableEffect , RequestGroup , ResearchDefinition , ResearchElementDefinition , RiskEvidenceSynthesis , SubstanceSpecification , Type , Any
  • Add codes Base , DataType , Availability , BackboneType , CodeableReference , ExtendedContactDetail , MonetaryComponent , PrimitiveType , integer64 , RatioRange , VirtualServiceDetail , ActorDefinition , AdministrableProductDefinition , ArtifactAssessment , BiologicallyDerivedProductDispense , CanonicalResource , Citation , ClinicalUseDefinition , ConditionDefinition , DeviceAssociation , DeviceDispense , DeviceUsage , EncounterHistory , EvidenceReport , FormularyItem , GenomicStudy , ImagingSelection , Ingredient , InventoryItem , InventoryReport , ManufacturedItemDefinition , MedicinalProductDefinition , MetadataResource , NutritionIntake , NutritionProduct , PackagedProductDefinition , Permission , RegulatedAuthorization , RequestOrchestration , Requirements , SubscriptionStatus , SubscriptionTopic , SubstanceDefinition , TestPlan , Transport
OperationDefinition.parameter.allowedType
  • Added Element

See the Full Difference for further information

This analysis is available for R4 as XML or JSON . Conversions between R3 and R4 for R4B as XML or JSON .

See R3 <--> R4 <--> R5 Conversion Maps (status = 37 tests that all execute ok. All tests pass round-trip testing and 34 r3 resources are invalid (0 errors). ) See Conversions Summary .)

Structure

Name Flags Card. Type Description & Constraints doco
. . OperationDefinition N DomainResource Definition of an operation or a named query
+ Warning: Name should be usable as an identifier for the module by machine processing applications such as code generation
+ Rule: A query operation cannot be defined at the instance level
+ Rule: A query operation requires input parameters to have a search type
+ Rule: Named queries always have a single output parameter named 'result' of type Bundle

Elements defined in Ancestors: id , meta , implicitRules , language , text , contained , extension , modifierExtension
Interfaces Implemented: CanonicalResource
. . . url Σ C 0..1 uri Canonical identifier for this operation definition, represented as a an absolute URI (globally unique)
+ Warning: URL should not contain | or # - these characters make processing canonical references problematic
. . version . identifier Σ TU 0..1 0..* Identifier Additional identifier for the implementation guide (business identifier)

... version Σ 0..1 string Business version of the operation definition
. . . versionAlgorithm[x] Σ TU 0..1 How to compare versions
Binding: Version Algorithm ( Extensible )
.... versionAlgorithmString string
.... versionAlgorithmCoding Coding
. . . name Σ C 1..1 string Name for this operation definition (computer friendly)
. . . title Σ T 0..1 string Name for this operation definition (human friendly)
. . . status ?! Σ 1..1 code draft | active | retired | unknown
Binding: PublicationStatus ( Required )
. . . kind Σ C 1..1 code operation | query
Binding: OperationKind Operation Kind ( Required )
. . . experimental Σ 0..1 boolean For testing purposes, not real usage
. . . date Σ 0..1 dateTime Date last changed
. . . publisher Σ T 0..1 string Name of the publisher publisher/steward (organization or individual)
. . . contact Σ 0..* ContactDetail Contact details for the publisher

. . . description T 0..1 markdown Natural language description of the operation definition
. . . useContext Σ TU 0..* UsageContext The context that the content is intended to support

. . . jurisdiction Σ XD 0..* CodeableConcept Intended jurisdiction for operation definition (if applicable)
Binding: Jurisdiction ValueSet ( Extensible )

. . . purpose T 0..1 markdown Why this operation definition is defined
. . . copyright T TU 0..1 markdown Use and/or publishing restrictions
... copyrightLabel T TU 0..1 string Copyright holder and year(s)
... affectsState Σ 0..1 boolean Whether content is changed by the operation
. . . code Σ 1..1 code Name used to invoke the Recommended name for operation in search url
. . . comment 0..1 markdown Additional information about use
. . . base Σ 0..1 canonical ( OperationDefinition ) Marks this as a profile of the base
. . . resource Σ 0..* code Types this operation applies to
ResourceType Binding: Version Independent Resource Types (All) ( Required )
Additional Bindings Purpose
All Resource Types UI Binding


. . . system Σ 1..1 boolean Invoke at the system level?
. . . type Σ 1..1 boolean Invoke at the type level?
. . . instance Σ C 1..1 boolean Invoke on an instance?
. . . inputProfile 0..1 canonical ( StructureDefinition ) Validation information for in parameters
. . . outputProfile 0..1 canonical ( StructureDefinition ) Validation information for out parameters
. . . parameter I C 0..* BackboneElement Parameters for the operation/query
+ Rule: Either a type must be provided, or parts
+ Rule: A search type can only be specified for parameters of type string
+ Rule: A targetProfile can only be specified for parameters of type Reference Reference, Canonical, or Canonical a Resource
+ Rule: SearchParamType can only be specified on in parameters

. . . . name C 1..1 code Name in Parameters.parameter.name or in URL
. . . . use C 1..1 code in | out
Binding: OperationParameterUse Operation Parameter Use ( Required )
. . . . min scope TU 1..1 0..* integer code Minimum Cardinality instance | type | system
Binding: Operation Parameter Scope ( Required )

. . . . max min 1..1 integer Minimum Cardinality
.... max 1..1 string Maximum Cardinality (a number or *)
. . . . documentation T 0..1 markdown Description of meaning/use
. . . . documentation type C 0..1 string code Description of meaning/use What type this parameter has
Binding: All FHIR Types ( Required )
. . . . type allowedType I TU 0..1 0..* code What type Allowed sub-type this parameter has can have (if type is abstract)
FHIRAllTypes Binding: All FHIR Types ( Required )

. . . . targetProfile C 0..* canonical ( StructureDefinition ) If type is Reference | canonical, allowed targets targets. If type is 'Resource', then this constrains the allowed resource types

. . . . searchType I C 0..1 code number | date | string | token | reference | composite | quantity | uri | special
Binding: SearchParamType ( Required )
. . . . binding 0..1 BackboneElement ValueSet details if this is coded
. . . . . strength 1..1 code required | extensible | preferred | example
Binding: BindingStrength ( Required )
. . . . . valueSet 1..1 canonical ( ValueSet ) Source of value set
. . . . referencedFrom TU 0..* BackboneElement References to this parameter

. . . . . source 1..1 string Referencing parameter
. . . . . sourceId 0..1 string Element id of reference
. . . . part I C 0..* see parameter Parts of a nested Parameter

. . . overload 0..* BackboneElement Define overloaded variants for when generating code

. . . . parameterName 0..* string Name of parameter to include in overload

. . . . comment 0..1 string Comments to go on overload

doco Documentation for this format icon

See the Extensions for this resource

UML Diagram ( Legend )

OperationDefinition ( DomainResource ) + CanonicalResource 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 url : uri [0..1] 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 identifier : Identifier [0..*] 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 version : string [0..1] Indicates the mechanism used to compare versions to determine which is more current versionAlgorithm[x] : DataType [0..1] « string | Coding ; null (Strength=Extensible) VersionAlgorithm + » 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 name : string [1..1] « This element has or is affected by some invariants C » A short, descriptive, user-friendly title for the operation definition title : string [0..1] The status current state of this operation definition. Enables tracking the life-cycle of the content definition (this element modifies the meaning of other elements) status : code [1..1] « null (Strength=Required) PublicationStatus ! » Whether this is an operation or a named query kind : code [1..1] « null (Strength=Required) OperationKind ! » « This element has or is affected by some invariants C » 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 experimental : boolean [0..1] The date (and optionally time) when the operation definition was published. 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 date : dateTime [0..1] The name of the organization or individual that published responsible for the release and ongoing maintenance of the operation definition publisher : string [0..1] Contact details to assist a user in finding and communicating with the publisher contact : ContactDetail [0..*] A free text natural language description of the operation definition from a consumer's perspective description : markdown [0..1] 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 instances useContext : UsageContext [0..*] A legal or geographic region in which the operation definition is intended to be used jurisdiction : CodeableConcept [0..*] « null (Strength=Extensible) Jurisdiction ValueSet JurisdictionValueSet + » Explanation of why this operation definition is needed and why it has been designed as it has purpose : markdown [0..1] 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 copyright : markdown [0..1] 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') copyrightLabel : string [0..1] Whether the operation affects state. Side effects such as producing audit trail entries do not count as 'affecting state' affectsState : boolean [0..1] The name label that is recommended to be used in the URL for this operation. In some cases, servers may need to invoke use a different CapabilityStatement operation.name to differentiate between multiple SearchParameters that happen to have the operation same code code : code [1..1] Additional information about how to use this operation or named query comment : markdown [0..1] Indicates that this operation definition is a constraining profile on the base base : canonical [0..1] « OperationDefinition » The types on which this operation can be executed resource : code [0..*] « null (Strength=Required) ResourceType VersionIndependentResourceTyp... ! » 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) system : boolean [1..1] 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) type : boolean [1..1] Indicates whether this operation can be invoked on a particular instance of one of the given types instance : boolean [1..1] « This element has or is affected by some invariants C » 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 inputProfile : canonical [0..1] « StructureDefinition » Additional validation information for the out parameters - a single profile that covers all the parameters. The profile is a constraint on the parameters resource outputProfile : canonical [0..1] « StructureDefinition » Parameter The name of used to identify the parameter name : code [1..1] « This element has or is affected by some invariants C » Whether this is an input or an output parameter use : code [1..1] « null (Strength=Required) OperationParameterUse ! » « This element has or is affected by some invariants C » If present, indicates that the parameter applies when the operation is being invoked at the specified level scope : code [0..*] « null (Strength=Required) OperationParameterScope ! » The minimum number of times this parameter SHALL appear in the request or response min : integer [1..1] The maximum number of times this element is permitted to appear in the request or response max : string [1..1] Describes the meaning or use of this parameter documentation : string markdown [0..1] The type for this parameter type : code [0..1] « null (Strength=Required) FHIRAllTypes FHIRTypes ! » « This element has or is affected by some invariants C » Support for polymorphic types. If the parameter type is abstract, this element lists allowed sub-types for the parameter allowedType : code [0..*] « null (Strength=Required) FHIRTypes ! » 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 targetProfile : canonical [0..*] « StructureDefinition » « This element has or is affected by some invariants C » How the parameter is understood if/when it used as a search parameter. This is only used if the parameter type is 'string' a string searchType : code [0..1] « null (Strength=Required) SearchParamType ! » « This element has or is affected by some invariants C » Binding 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 strength : code [1..1] « null (Strength=Required) BindingStrength ! » Points to the value set or external definition (e.g. implicit value set) that identifies the set of codes to be used valueSet : canonical [1..1] « ValueSet » ReferencedFrom 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 source : string [1..1] The id of the element in the referencing resource that is expected to resolve to this resource sourceId : string [0..1] Overload Name of parameter to include in overload parameterName : string [0..*] Comments to go on overload comment : string [0..1] Binds to a value set if this parameter is coded (code, Coding, CodeableConcept) binding [0..1] Identifies other resource parameters within the operation invocation that are expected to resolve to this resource referencedFrom [0..*] The parts of a nested Parameter part [0..*] The parameters for the operation/query parameter [0..*] Defines an appropriate combination of parameters to use when invoking this operation, to help code generators when generating overloaded parameter sets for this operation overload [0..*]

XML Template 

<OperationDefinition xmlns="http://hl7.org/fhir"> doco
 <!-- from Resource: id, meta, implicitRules, and language -->
 <!-- from DomainResource: text, contained, extension, and modifierExtension -->
 <

 <url value="[uri]"/><!-- 0..1 Canonical identifier for this operation definition, represented as an absolute URI (globally unique) -->
 <identifier><!-- 0..* Identifier Additional identifier for the implementation guide (business identifier) --></identifier>

 <version value="[string]"/><!-- 0..1 Business version of the operation definition -->
 <

 <versionAlgorithm[x]><!-- 0..1 string|Coding How to compare versions --></versionAlgorithm[x]>
 <name value="[string]"/><!-- I 1..1 Name for this operation definition (computer friendly) -->

 <title value="[string]"/><!-- 0..1 Name for this operation definition (human friendly) -->
 <
 <
 <
 <
 <

 <status value="[code]"/><!-- 1..1 draft | active | retired | unknown -->
 <kind value="[code]"/><!-- I 1..1 operation | query -->
 <experimental value="[boolean]"/><!-- 0..1 For testing purposes, not real usage -->
 <date value="[dateTime]"/><!-- 0..1 Date last changed -->
 <publisher value="[string]"/><!-- 0..1 Name of the publisher/steward (organization or individual) -->

 <contact><!-- 0..* ContactDetail Contact details for the publisher --></contact>
 <description value="[markdown]"/><!-- 0..1 Natural language description of the operation definition -->
 <</useContext>

 <useContext><!-- 0..* UsageContext The context that the content is intended to support --></useContext>

 <jurisdiction><!-- 0..* CodeableConcept Intended jurisdiction for operation definition (if applicable) --></jurisdiction>
 <purpose value="[markdown]"/><!-- 0..1 Why this operation definition is defined -->
 <copyright value="[markdown]"/><!-- 0..1 Use and/or publishing restrictions -->
 <copyrightLabel value="[string]"/><!-- 0..1 Copyright holder and year(s) -->

 <affectsState value="[boolean]"/><!-- 0..1 Whether content is changed by the operation -->
 <

 <code value="[code]"/><!-- 1..1 Recommended name for operation in search url -->

 <comment value="[markdown]"/><!-- 0..1 Additional information about use -->
 <base><!-- 0..1 canonical(OperationDefinition) Marks this as a profile of the base --></base>
 <

 <resource value="[code]"/><!-- 0..* Types this operation applies to -->

 <system value="[boolean]"/><!-- 1..1 Invoke at the system level? -->
 <type value="[boolean]"/><!-- 1..1 Invoke at the type level? -->
 <

 <instance value="[boolean]"/><!-- I 1..1 Invoke on an instance? -->

 <inputProfile><!-- 0..1 canonical(StructureDefinition) Validation information for in parameters --></inputProfile>
 <outputProfile><!-- 0..1 canonical(StructureDefinition) Validation information for out parameters --></outputProfile>
 <
  <
  <

 <parameter>  <!-- I 0..* Parameters for the operation/query -->
  <name value="[code]"/><!-- I 1..1 Name in Parameters.parameter.name or in URL -->
  <use value="[code]"/><!-- I 1..1 in | out -->
  <scope value="[code]"/><!-- 0..* instance | type | system -->

  <min value="[integer]"/><!-- 1..1 Minimum Cardinality -->
  <max value="[string]"/><!-- 1..1 Maximum Cardinality (a number or *) -->
  <
  <
  <</targetProfile>
  <

  <documentation value="[markdown]"/><!-- 0..1 Description of meaning/use -->
  <type value="[code]"/><!-- I 0..1 What type this parameter has -->
  <allowedType value="[code]"/><!-- 0..* Allowed sub-type this parameter can have (if type is abstract) -->
  <targetProfile><!-- I 0..* canonical(StructureDefinition) If type is Reference | canonical, allowed targets. If type is 'Resource', then this constrains the allowed resource types --></targetProfile>
  <searchType value="[code]"/><!-- I 0..1 number | date | string | token | reference | composite | quantity | uri | special -->

  <binding>  <!-- 0..1 ValueSet details if this is coded -->
   <strength value="[code]"/><!-- 1..1 required | extensible | preferred | example -->
   <valueSet><!-- 1..1 canonical(ValueSet) Source of value set --></valueSet>
  </binding>
  <referencedFrom>  <!-- 0..* References to this parameter -->
   <source value="[string]"/><!-- 1..1 Referencing parameter -->
   <sourceId value="[string]"/><!-- 0..1 Element id of reference -->
  </referencedFrom>
  <</part>

  <part><!-- I 0..* Content as for OperationDefinition.parameter Parts of a nested Parameter --></part>

 </parameter>
 <overload>  <!-- 0..* Define overloaded variants for when  generating code -->
  <parameterName value="[string]"/><!-- 0..* Name of parameter to include in overload -->
  <comment value="[string]"/><!-- 0..1 Comments to go on overload -->
 </overload>
</OperationDefinition>

JSON Template 

{doco
  "resourceType" : "OperationDefinition",
  // from Resource: id, meta, implicitRules, and language
  // from DomainResource: text, contained, extension, and modifierExtension
  "

  "url" : "<uri>", // Canonical identifier for this operation definition, represented as an absolute URI (globally unique)
  "identifier" : [{ Identifier }], // Additional identifier for the implementation guide (business identifier)

  "version" : "<string>", // Business version of the operation definition
  "

  // versionAlgorithm[x]: How to compare versions. One of these 2:
  "versionAlgorithmString" : "<string>",
  "versionAlgorithmCoding" : { Coding },
  "name" : "<string>", // I R!  Name for this operation definition (computer friendly)

  "title" : "<string>", // Name for this operation definition (human friendly)
  "
  "
  "
  "
  "

  "status" : "<code>", // R!  draft | active | retired | unknown
  "kind" : "<code>", // I R!  operation | query
  "experimental" : <boolean>, // For testing purposes, not real usage
  "date" : "<dateTime>", // Date last changed
  "publisher" : "<string>", // Name of the publisher/steward (organization or individual)

  "contact" : [{ ContactDetail }], // Contact details for the publisher
  "description" : "<markdown>", // Natural language description of the operation definition
  "

  "useContext" : [{ UsageContext }], // The context that the content is intended to support

  "jurisdiction" : [{ CodeableConcept }], // Intended jurisdiction for operation definition (if applicable)
  "purpose" : "<markdown>", // Why this operation definition is defined
  "copyright" : "<markdown>", // Use and/or publishing restrictions
  "copyrightLabel" : "<string>", // Copyright holder and year(s)

  "affectsState" : <boolean>, // Whether content is changed by the operation
  "

  "code" : "<code>", // R!  Recommended name for operation in search url

  "comment" : "<markdown>", // Additional information about use
  "
  "

  "base" : "<canonical(OperationDefinition)>", // Marks this as a profile of the base
  "resource" : ["<code>"], // Types this operation applies to

  "system" : <boolean>, // R!  Invoke at the system level?
  "type" : <boolean>, // R!  Invoke at the type level?
  "
  "
  "
  "
    "
    "

  "instance" : <boolean>, // I R!  Invoke on an instance?
  "inputProfile" : "<canonical(StructureDefinition)>", // Validation information for in parameters
  "outputProfile" : "<canonical(StructureDefinition)>", // Validation information for out parameters
  "parameter" : [{ // I Parameters for the operation/query
    "name" : "<code>", // I R!  Name in Parameters.parameter.name or in URL
    "use" : "<code>", // I R!  in | out
    "scope" : ["<code>"], // instance | type | system

    "min" : <integer>, // R!  Minimum Cardinality
    "max" : "<string>", // R!  Maximum Cardinality (a number or *)
    "
    "
    "
    "

    "documentation" : "<markdown>", // Description of meaning/use
    "type" : "<code>", // I What type this parameter has
    "allowedType" : ["<code>"], // Allowed sub-type this parameter can have (if type is abstract)
    "targetProfile" : ["<canonical(StructureDefinition)>"], // I If type is Reference | canonical, allowed targets. If type is 'Resource', then this constrains the allowed resource types
    "searchType" : "<code>", // I number | date | string | token | reference | composite | quantity | uri | special

    "binding" : { // ValueSet details if this is coded
      "strength" : "<code>", // R!  required | extensible | preferred | example
      "

      "valueSet" : "<canonical(ValueSet)>" // R!  Source of value set

    },
    "referencedFrom" : [{ // References to this parameter
      "source" : "<string>", // R!  Referencing parameter
      "sourceId" : "<string>" // Element id of reference
    }],
    "

    "part" : [{ Content as for OperationDefinition.parameter }] // I Parts of a nested Parameter

  }],
  "overload" : [{ // Define overloaded variants for when  generating code
    "parameterName" : ["<string>"], // Name of parameter to include in overload
    "comment" : "<string>" // Comments to go on overload
  }]
}

Turtle Template 

@prefix fhir: <http://hl7.org/fhir/> .doco


[ a fhir:OperationDefinition;
  fhir:nodeRole fhir:treeRoot; # if this is the parser root

  # from Resource: .id, .meta, .implicitRules, and .language
  # from DomainResource: .text, .contained, .extension, and .modifierExtension
  fhir:
  fhir:
  fhir:
  fhir:
  fhir:
  fhir:
  fhir:
  fhir:
  fhir:
  fhir:
  fhir:
  fhir:
  fhir:
  fhir:
  fhir:
  fhir:
  fhir:
  fhir:
  fhir:
  fhir:
  fhir:
  fhir:
  fhir:
  fhir:
  fhir:
    fhir:
    fhir:
    fhir:
    fhir:
    fhir:
    fhir:
    fhir:
    fhir:
    fhir:
      fhir:
      fhir:
    ];
    fhir:
      fhir:
      fhir:
    ], ...;
    fhir:
  ], ...;
  fhir:
    fhir:
    fhir:
  ], ...;

  fhir:url [ uri ] ; # 0..1 Canonical identifier for this operation definition, represented as an absolute URI (globally unique)
  fhir:identifier  ( [ Identifier ] ... ) ; # 0..* Additional identifier for the implementation guide (business identifier)
  fhir:version [ string ] ; # 0..1 Business version of the operation definition
  # versionAlgorithm[x] : 0..1 How to compare versions. One of these 2
    fhir:versionAlgorithm [  a fhir:string ; string ]
    fhir:versionAlgorithm [  a fhir:Coding ; Coding ]
  fhir:name [ string ] ; # 1..1 I Name for this operation definition (computer friendly)
  fhir:title [ string ] ; # 0..1 Name for this operation definition (human friendly)
  fhir:status [ code ] ; # 1..1 draft | active | retired | unknown
  fhir:kind [ code ] ; # 1..1 I operation | query
  fhir:experimental [ boolean ] ; # 0..1 For testing purposes, not real usage
  fhir:date [ dateTime ] ; # 0..1 Date last changed
  fhir:publisher [ string ] ; # 0..1 Name of the publisher/steward (organization or individual)
  fhir:contact  ( [ ContactDetail ] ... ) ; # 0..* Contact details for the publisher
  fhir:description [ markdown ] ; # 0..1 Natural language description of the operation definition
  fhir:useContext  ( [ UsageContext ] ... ) ; # 0..* The context that the content is intended to support
  fhir:jurisdiction  ( [ CodeableConcept ] ... ) ; # 0..* Intended jurisdiction for operation definition (if applicable)
  fhir:purpose [ markdown ] ; # 0..1 Why this operation definition is defined
  fhir:copyright [ markdown ] ; # 0..1 Use and/or publishing restrictions
  fhir:copyrightLabel [ string ] ; # 0..1 Copyright holder and year(s)
  fhir:affectsState [ boolean ] ; # 0..1 Whether content is changed by the operation
  fhir:code [ code ] ; # 1..1 Recommended name for operation in search url
  fhir:comment [ markdown ] ; # 0..1 Additional information about use
  fhir:base [ canonical(OperationDefinition) ] ; # 0..1 Marks this as a profile of the base
  fhir:resource  ( [ code ] ... ) ; # 0..* Types this operation applies to
  fhir:system [ boolean ] ; # 1..1 Invoke at the system level?
  fhir:type [ boolean ] ; # 1..1 Invoke at the type level?
  fhir:instance [ boolean ] ; # 1..1 I Invoke on an instance?
  fhir:inputProfile [ canonical(StructureDefinition) ] ; # 0..1 Validation information for in parameters
  fhir:outputProfile [ canonical(StructureDefinition) ] ; # 0..1 Validation information for out parameters
  fhir:parameter ( [ # 0..* I Parameters for the operation/query
    fhir:name [ code ] ; # 1..1 I Name in Parameters.parameter.name or in URL
    fhir:use [ code ] ; # 1..1 I in | out
    fhir:scope  ( [ code ] ... ) ; # 0..* instance | type | system
    fhir:min [ integer ] ; # 1..1 Minimum Cardinality
    fhir:max [ string ] ; # 1..1 Maximum Cardinality (a number or *)
    fhir:documentation [ markdown ] ; # 0..1 Description of meaning/use
    fhir:type [ code ] ; # 0..1 I What type this parameter has
    fhir:allowedType  ( [ code ] ... ) ; # 0..* Allowed sub-type this parameter can have (if type is abstract)
    fhir:targetProfile  ( [ canonical(StructureDefinition) ] ... ) ; # 0..* I If type is Reference | canonical, allowed targets. If type is 'Resource', then this constrains the allowed resource types
    fhir:searchType [ code ] ; # 0..1 I number | date | string | token | reference | composite | quantity | uri | special
    fhir:binding [ # 0..1 ValueSet details if this is coded
      fhir:strength [ code ] ; # 1..1 required | extensible | preferred | example
      fhir:valueSet [ canonical(ValueSet) ] ; # 1..1 Source of value set
    ] ;
    fhir:referencedFrom ( [ # 0..* References to this parameter
      fhir:source [ string ] ; # 1..1 Referencing parameter
      fhir:sourceId [ string ] ; # 0..1 Element id of reference
    ] ... ) ;
    fhir:part  ( [ See OperationDefinition.parameter ] ... ) ; # 0..* I Parts of a nested Parameter
  ] ... ) ;
  fhir:overload ( [ # 0..* Define overloaded variants for when  generating code
    fhir:parameterName  ( [ string ] ... ) ; # 0..* Name of parameter to include in overload
    fhir:comment [ string ] ; # 0..1 Comments to go on overload
  ] ... ) ;

]

Changes since Release 4 from both R4 and R4B

OperationDefinition
OperationDefinition.identifier
  • No Changes Added Element
OperationDefinition.versionAlgorithm[x]
  • Added Element
OperationDefinition.copyright
  • Added Element
OperationDefinition.copyrightLabel
  • Added Element
OperationDefinition.resource
  • Change value set from http://hl7.org/fhir/ValueSet/resource-types|4.0.0 to Version Independent Resource Types (All)
  • Add codes ActorDefinition , AdministrableProductDefinition , ArtifactAssessment , BiologicallyDerivedProductDispense , CanonicalResource , Citation , ClinicalUseDefinition , ConditionDefinition , DeviceAssociation , DeviceDispense , DeviceUsage , EncounterHistory , EvidenceReport , FormularyItem , GenomicStudy , ImagingSelection , Ingredient , InventoryItem , InventoryReport , ManufacturedItemDefinition , MedicinalProductDefinition , MetadataResource , NutritionIntake , NutritionProduct , PackagedProductDefinition , Permission , RegulatedAuthorization , RequestOrchestration , Requirements , SubscriptionStatus , SubscriptionTopic , SubstanceDefinition , TestPlan , Transport , BodySite , Conformance , DataElement , DeviceComponent , DeviceUseRequest , DiagnosticOrder , EligibilityRequest , EligibilityResponse , ExpansionProfile , ImagingManifest , ImagingObjectSelection , MedicationOrder , MedicationUsage , Order , OrderResponse , ProcedureRequest , ProcessRequest , ProcessResponse , ReferralRequest , Sequence , ServiceDefinition
OperationDefinition.parameter.scope
  • Added Element
OperationDefinition.parameter.documentation
  • Type changed from string to markdown
OperationDefinition.parameter.type
  • Change value set from http://hl7.org/fhir/ValueSet/all-types|4.0.0 to All FHIR Types
  • Remove codes MoneyQuantity , Population , ProdCharacteristic , SimpleQuantity , SubstanceAmount , CatalogEntry , DeviceUseStatement , DocumentManifest , EffectEvidenceSynthesis , Media , MedicinalProduct , MedicinalProductAuthorization , MedicinalProductContraindication , MedicinalProductIndication , MedicinalProductIngredient , MedicinalProductInteraction , MedicinalProductManufactured , MedicinalProductPackaged , MedicinalProductPharmaceutical , MedicinalProductUndesirableEffect , RequestGroup , ResearchDefinition , ResearchElementDefinition , RiskEvidenceSynthesis , SubstanceSpecification , Type , Any
  • Add codes Base , DataType , Availability , BackboneType , CodeableReference , ExtendedContactDetail , MonetaryComponent , PrimitiveType , integer64 , RatioRange , VirtualServiceDetail , ActorDefinition , AdministrableProductDefinition , ArtifactAssessment , BiologicallyDerivedProductDispense , CanonicalResource , Citation , ClinicalUseDefinition , ConditionDefinition , DeviceAssociation , DeviceDispense , DeviceUsage , EncounterHistory , EvidenceReport , FormularyItem , GenomicStudy , ImagingSelection , Ingredient , InventoryItem , InventoryReport , ManufacturedItemDefinition , MedicinalProductDefinition , MetadataResource , NutritionIntake , NutritionProduct , PackagedProductDefinition , Permission , RegulatedAuthorization , RequestOrchestration , Requirements , SubscriptionStatus , SubscriptionTopic , SubstanceDefinition , TestPlan , Transport
OperationDefinition.parameter.allowedType
  • Added Element

See the Full Difference for further information

This analysis is available for R4 as XML or JSON . Conversions between R3 and R4 for R4B as XML or JSON .

See R3 <--> R4 <--> R5 Conversion Maps (status = 37 tests that all execute ok. All tests pass round-trip testing and 34 r3 resources are invalid (0 errors). ) See Conversions Summary .)

 

See the Profiles & Extensions and the alternate Additional definitions: Master Definition XML + JSON , XML Schema / Schematron + JSON Schema , ShEx (for Turtle ) + see , the extensions spreadsheet version & the dependency analysis

5.4.4.1 5.5.4.1 Terminology Bindings

OperationDefinition.parameter.searchType
Path Definition ValueSet Type Reference Documentation
OperationDefinition.versionAlgorithm[x] VersionAlgorithm Extensible

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

OperationDefinition.status PublicationStatus Required PublicationStatus

The lifecycle status of an artifact.

OperationDefinition.kind OperationKind Required OperationKind

Whether an operation is a normal operation or a query.

OperationDefinition.jurisdiction JurisdictionValueSet Extensible Jurisdiction ValueSet

This value set defines a base set of codes for country, country subdivision and region for indicating where a resource is intended to be used.

Note: The codes for countries and country subdivisions are taken from ISO 3166 icon while the codes for "supra-national" regions are from UN Standard country or area codes for statistical use (M49) icon.
OperationDefinition.resource VersionIndependentResourceTypesAll Required ResourceType

Current and past FHIR resource types (deleted or renamed), including abstract types

  All Resource Types ui
OperationDefinition.parameter.use OperationParameterUse Required OperationParameterUse

Whether an operation parameter is an input or an output parameter.

OperationDefinition.parameter.scope OperationParameterScope (a valid code from Operation Parameter Use ) Required

Indicates that a parameter applies when the operation is being invoked at the specified level

OperationDefinition.parameter.type FHIRTypes (a valid code from All FHIR Types ) Required FHIRAllTypes

All FHIR types

OperationDefinition.parameter.allowedType FHIRTypes (a valid code from All FHIR Types ) Required

All FHIR types

OperationDefinition.parameter.searchType SearchParamType Required

Data types allowed to be used for search parameters.

OperationDefinition.parameter.binding.strength BindingStrength Required BindingStrength

Indication of the degree of conformance expectations associated with a binding.

5.4.4.2 5.5.4.2 Constraints

5.4.4.3 Operations defined as part of this Specification Base Operations (All resource types) Validate a resource [base]/[Resource]/$validate | [base]/[Resource]/[id]/$validate Apply [base]/ActivityDefinition/$apply | [base]/ActivityDefinition/[id]/$apply Closure Table Maintenance [base]/$closure
id UniqueKey Level Location Description Expression
opd-0 img  cnl-0 Warning (base) 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]([A-Za-z0-9_]){0,254}') name.matches('^[A-Z]([A-Za-z0-9_]){1,254}$')
opd-1 img  cnl-1 Warning OperationDefinition.url URL should not contain | or # - these characters make processing canonical references problematic exists() implies matches('^[^|# ]+$')
img  opd-1 Rule OperationDefinition.parameter Either a type must be provided, or parts type.exists() or part.exists()
opd-2 img  opd-2 Rule OperationDefinition.parameter A search type can only be specified for parameters of type string searchType.exists() implies type = 'string'
opd-3 img  opd-3 Rule OperationDefinition.parameter A targetProfile can only be specified for parameters of type Reference Reference, Canonical, or Canonical a Resource targetProfile.exists() implies (type = 'Reference' or type = 'canonical') 'canonical' or type.memberOf('http://hl7.org/fhir/ValueSet/resource-types'))
Access a list of profiles, tags, and security labels [base]/$meta | [base]/[Resource]/$meta | [base]/[Resource]/[id]/$meta Add profiles, tags, and security labels to a resource img  opd-4 [base]/[Resource]/[id]/$meta-add Delete profiles, tags, and security labels for a resource Rule [base]/[Resource]/[id]/$meta-delete Convert from one form to another OperationDefinition.parameter [base]/$convert SearchParamType can only be specified on in parameters Execute a graphql statement (use = 'out') implies searchType.empty() [base]/$graphql | [base]/[Resource]/[id]/$graphql
Return a graph of resources [base]/[Resource]/[id]/$graph Operations Defined by Resource Types img  opd-5 Data Requirements Rule [base]/ActivityDefinition/[id]/$data-requirements (base) Fetch a subset of A query operation cannot be defined at the CapabilityStatement resource [base]/CapabilityStatement/$subset | [base]/CapabilityStatement/[id]/$subset Test if a server implements a client's required operations [base]/CapabilityStatement/$implements | [base]/CapabilityStatement/[id]/$implements instance level Test if a server implements a client's required operations (kind = 'query') implies (instance = false) [base]/CapabilityStatement/$conforms
Discover what versions a server supports img  opd-6 [base]/$versions Apply Rule [base]/ChargeItemDefinition/[id]/$apply (base) Submit A query operation requires input parameters to have a Claim resource for adjudication [base]/Claim/$submit Concept Look Up & Decomposition [base]/CodeSystem/$lookup search type Code System based Validation (kind = 'query') implies (parameter.all((use = 'in' and searchType.exists()) or (use != 'in'))) [base]/CodeSystem/$validate-code | [base]/CodeSystem/[id]/$validate-code
Subsumption Testing img  opd-7 [base]/CodeSystem/$subsumes | [base]/CodeSystem/[id]/$subsumes Finding codes based on supplied properties Rule [base]/CodeSystem/$find-matches | [base]/CodeSystem/[id]/$find-matches (base) Generate Named queries always have a Document [base]/Composition/$document | [base]/Composition/[id]/$document single output parameter named 'result' of type Bundle Concept Translation (kind = 'query') implies ((parameter.where(use = 'out').count() = 1) and (parameter.where(use = 'out').all(name = 'result' and type = 'Bundle'))) [base]/ConceptMap/$translate | [base]/ConceptMap/[id]/$translate

Submit an EligibilityRequest resource for assessment

[base]/CoverageEligibilityRequest/$submit 5.5.4.3 Derived OperationDefinitions Fetch Encounter Record [base]/Encounter/[id]/$everything Fetch

OperationDefinitions can describe entirely new operations, but they can also describe a group restricted implementation of Patient Records [base]/Group/[id]/$everything Data Requirements [base]/$data-requirements | [base]/Library/[id]/$data-requirements Find an existing operation e.g. when a functional list [base]/List/$find Evaluate Measure [base]/Measure/$evaluate-measure | [base]/Measure/[id]/$evaluate-measure Data Requirements [base]/Measure/[id]/$data-requirements Submit Data [base]/Measure/$submit-data | [base]/Measure/[id]/$submit-data Collect Data [base]/Measure/$collect-data | [base]/Measure/[id]/$collect-data Care Gaps [base]/Measure/$care-gaps Fetch Product Record [base]/MedicinalProductDefinition/$everything | [base]/MedicinalProductDefinition/[id]/$everything Process Message [base]/$process-message Fetch Preferred server implements some but not all the features of an operation defined in another specification. These are called derived operation definitions.

An OperationDefinition does by declaring a base as shown in the example :


{
  "resourceType" : "OperationDefinition",
  "id" : "example",
  "url" : "http://hl7.org/fhir/OperationDefinition/example",
  "name" : "PopulateQuestionnaire",
  // snip
  "code" : "populate",
  "base" : "http://hl7.org/fhir/OperationDefinition/Questionnaire-populate"
  // snip
}

When constraining an existing operation like this, operation definitions can make optional parameters required or not used, introduce new parameters (required or optional), clarify documentation, and even change the code for the operation (see next section). The derived operation can't change the nature of the operation itself, nor can it [base]/NamingSystem/$preferred-id Observation Statistics [base]/Observation/$stats Last N Observations Query [base]/Observation/$lastn Find patient matches using MPI based logic [base]/Patient/$match Fetch Patient Record [base]/Patient/$everything | [base]/Patient/[id]/$everything Apply [base]/PlanDefinition/$apply | [base]/PlanDefinition/[id]/$apply Data Requirements [base]/PlanDefinition/[id]/$data-requirements change add types to parameters or prohibit mandatory parameters.

Build Questionnaire [base]/StructureDefinition/$questionnaire | [base]/StructureDefinition/[id]/$questionnaire Generate Snapshot

[base]/StructureDefinition/$snapshot | [base]/StructureDefinition/[id]/$snapshot 5.5.4.4 OperationDefinition Code Model Instance Transformation [base]/StructureMap/$transform | [base]/StructureMap/[id]/$transform

Operations are invoked by their code, not their name. The name is descriptive, for code generation, e.g. ValueSetExpansion , while the code is what is used in a URL e.g. http://example.org/fhir/ValueSet/$expand . When defining operations, for maximum compatibility, use only lowercase ASCII characters. See Naming Rules & Guidelines icon Value Set Expansion [base]/ValueSet/$expand | [base]/ValueSet/[id]/$expand Value Set based Validation for the internal HL7 rules around codes, which are useful additional advice for all implementers.

It is possible for two different organizations to create different operation definitions with the same code or, perhaps more likely, to define equivalent operations that have the same code but incompatible approaches in their parameter lists. Note that HL7 will never define multiple operations with the same code.

It is also possible, though unlikely, that a server will be required to support both of these operations. If this is the case, the server is able to do this by giving one of them a new code and referring to it by definition in the capability statement. To illustrate this, assume that two different organizations, "orgA" and "orgB", both define an operation with a code dothis , and the definitions are incompatible. OrgA publishes its operation definition at http://orga.com/fhir/dothis.xml, and OrgB publishes its operation at http://fhir.orgb.com/meta/OperationDefinition/dothis. The server is able to implement both. Its capability statement will say: 


<CapabilityStatement xmlns="http://hl7.org/fhir">
  <!-- snip -->
  <rest>
    <!-- snip -->
    <operation>
      <name value="dothis"/>
      <definition>
        <reference value="http://orga.com/fhir/dothis.xml"/>
      </definition>
    </operation>
    <operation>
      <name value="dothis2"/>
      <definition>
        <reference value="http://fhir.orgb.com/meta/OperationDefinition/dothis"/>
      </definition>
    </operation>
    <!-- snip -->
  </rest>
  <!-- snip -->
</CapabilityStatement>

If a general purpose cross server client is looking for the implementation of the http://fhir.orgb.com/meta/OperationDefinition/dothis operation and wants to be robust against this name clash problem, instead of simply executing the $dothis operation, it can look at the server's CapabilityStatement [base]/ValueSet/$validate-code | [base]/ValueSet/[id]/$validate-code for the underlying definition URI and then execute with the name given in the capability statement.

Note to implementers: it would be more consistent if CapabilityStatement.rest.operation.name was actually called "code", since it relates to OperationDefinition.code, but the confusion this can cause wasn't appreciated until the resource was normative.

5.4.4.4 5.5.4.5 Describing Operation Parameters

There are 2 ways to describe the input and output parameters for an operation:

  • Using OperationDefinition.parameter to describe the parameters
  • Using OperationDefinition.inputProfile and OperationDefinition.outputProfile

The parameters is a simple list of possible parameters, along with cardinalities and types. The profiles allow a rich set of validation rules etc. to be provided. OperationDefinitions SHALL always define the parameters using OperationDefinition.parameter in the resource, and MAY also provide profiles for the parameters. If present, the profiles SHALL NOT disagree with the parameters defined for the operation.

As an example, consider an operation that defines 3 parameters, 2 in and 1 out:

In Parameters:
Name Cardinality Type Binding Profile Documentation
a 0..1 integer

An integer parameter

b 0..1 Patient

A patient parameter

Out Parameters:
Name Cardinality Type Binding Profile Documentation
c 1..1 decimal

A result parameter

In addition to specifying the operation parameters directly, an operation definition can also provide a profile: 

 "inputProfile" : "http://example.org/StructureDefinition/op.x.in.profile"

This profile would describe a parameters resource with 2 parameters (using slicing), with the same details as the table above. The operation definition would still list the parameters directly to save applications consuming the definition (e.g. to produce an OpenAPI document icon ) from parsing and interpreting the profile.

5.4.4.5 5.5.4.6 Executing Operations

OperationDefinitions with kind = operation are executed as defined in the Operations Framework .

5.4.4.6 5.5.4.7 Executing Named Queries

Named queries (OperationDefinitions with kind = query ) are executed by performing a search with the value of the search parameter "_query" set to the name provided in the definition. Named queries are a kind of search: both client and server must conform to all the requirements of search, including regarding the content of the result bundle. From a client's perspective, it's really just a kind of search, though it may have a completely separate processing pipeline. Named queries cannot be invoked using the $[operationname] mechanism.

If the named query is to be performed over the RESTful API, all the parameters must be simple search parameters, so that they can be represented directly in the URL without tricky encoding issues. Named queries always return a bundle containing have a set single output parameter named "result" of type Bundle.

The order of resources, so all the out parameters must doesn't matter; a _query parameter anywhere in the query means the entire query will be resources, not data types. handled according to the named query OperationDefinition. Parameters may repeat if permitted by the OperationDefinition (or for unlisted common search parameters, as specified in this specification).

For named queries, all the standard search parameters are automatically in scope (though servers do not need scope. Specifically, all common search parameters (e.g. _id, _text, _count, _sort, etc.) as well as search parameters that pertain to the resources returned by the operation (e.g. name for Patient or Organization) are allowed. "In scope" doesn't mean all servers will support them unless them. If a server wishes to declare which search parameters it supports for a given named query, it must explicitly documented). list these in its OperationDefinition (which might be a server-specific derived OperationDefinition).

5.4.4.7 5.5.4.8 Passing Resources to Operations

There are two ways to pass resources to an operation: directly or by reference. The definition of an operation distinguishes between these two, since they have very different behaviors and consequences.

As an example, take the ValueSet.$expand operation . This operation takes a valueset as a direct parameter. The type of the parameter is defined as 'ValueSet'. In a Parameters resource, it would be represented like this: 

  <parameter>
    <name value="valueset"/>
    <resource>
      <ValueSet>
        <!-- Valueset contents -->

        <!-- ValueSet contents -->

      </ValueSet>
    </resource>
  </parameter>

or, in JSON: 

 "parameter": [
    {
      "name": "valueset",
      "resource": {
        "resourceType": "ValueSet",
        // Valueset contents 

        // ValueSet contents 

      }
    }
  ]

Other parameters are passed by reference. For example, the ChargeItemDefinition.$apply operation takes two parameters of type Reference - one to the chargeItem and the other to the account. The type of the parameters is Reference(Charge) and Reference(Account) , respectively. The expectation is that the server performing the operation will resolve those references as part of the operation execution. In a parameters resource, the chargeItem parameter would be represented like this: 

  <parameter>
    <name value="chargeItem"/>
    <valueReference>
      <reference value="ChargeItem/123"/>
    </valueReference>
  </parameter>

or, in JSON: 

 "parameter": [
    {
      "name": "chargeItem",
      "valueReference" : {
        "reference" : "ChargeItem/123"
      }
    }
  ]

Some operations can take either form; in that case, two distinct parameters must be defined: one for a resource as a direct parameter, and one for a reference.

5.4.4.8 Renaming OperationDefinition.name It is possible for two different organizations to create different operation definitions with the same name or, perhaps more likely, to define equivalent operations that have the same name but incompatible approaches in their parameter lists. It is also possible, though unlikely, that a server will be required to support both of these operations. If this is the case, the server is able to do this by giving one of them a new name and referring to it by definition in the capability statement. To illustrate this, assume that two different organizations, "orgA" and "orgB", both define an operation called "dothis", and the definitions are incompatible. OrgA publishes its operation definition at http://orga.com/fhir/dothis.xml, and OrgB publishes its operation at http://fhir.orgb.com/meta/OperationDefinition/dothis. The server is able to implement both. Its capability statement will say: <CapabilityStatement xmlns="http://hl7.org/fhir"> <!-- snip --> <rest> <!-- snip --> <operation> <name value="dothis"/> <definition> <reference value="http://orga.com/fhir/dothis.xml"/> </definition> </operation> <operation> <name value="dothis2"/> <definition> <reference value="http://fhir.orgb.com/meta/OperationDefinition/dothis"/> </definition> </operation> <!-- snip --> </rest> <!-- snip --> </CapabilityStatement> If a general purpose cross server client is looking for the implementation of the http://fhir.orgb.com/meta/OperationDefinition/dothis operation and wants to be robust against this name clash problem, instead of simply executing the $dothis operation, it can look at the server's CapabilityStatement for the underlying definition URI and then execute the name given in the capability statement.

5.4.4.9 5.5.4.9 Determining System Compatibility

A client can determine the compatibility of the server by processing its capability statement and ensuring that the server implements the specific operation definitions and parameters required by the client. The client can then report a useful error to the user rather than allowing mystifying operational errors to occur.

However, there are fundamental limitations to this approach because there are many aspects of these operations that are not (or cannot be) defined in a formal fashion using OperationDefinition, for example, co-occurrence constraints among parameters.

In the same sense, a 3rd party tool can examine a server's CapabilityStatement and a client's definition of an acceptable server to determine whether those two system are interoperable or not.

5.4.4.10 5.5.4.10 Dynamically Generating Forms

Finally, it is possible to generate user interface forms automatically from the OperationDefinition. The documentation in the OperationDefinition.description and OperationDefinition.parameter.documentation should be sufficient to allow moderately technical users to guess at the correct content of the form. For this reason, highly technical documentation should go in OperationDefinition.comment .

It is anticipated that this would be used to automate development processes, rather than to generate end-user forms: such users will usually need more support than can be offered in a generated form.

5.5.4.11 Operations defined as part of this Specification

Base Operations (All resource types)
Validate a resource [base]/[Resource]/$validate | [base]/[Resource]/[id]/$validate
Access a list of profiles, tags, and security labels [base]/$meta | [base]/[Resource]/$meta | [base]/[Resource]/[id]/$meta
Add profiles, tags, and security labels to a resource [base]/[Resource]/[id]/$meta-add
Delete profiles, tags, and security labels for a resource [base]/[Resource]/[id]/$meta-delete
Convert from one form to another [base]/$convert
Execute a graphql statement [base]/$graphql | [base]/[Resource]/[id]/$graphql
Return a graph of resources [base]/[Resource]/[id]/$graph
Add to an array in a large resource [base]/[Resource]/[id]/$add
Remove from an array in a large resource [base]/[Resource]/[id]/$remove
Filter an array in a large resource [base]/[Resource]/[id]/$filter
Fetch the current version of a canonical resource (based on canonical versioning) [base]/$current-canonical | [base]/[CanonicalResource]/$current-canonical
Operations Defined by Resource Types
Apply [base]/ActivityDefinition/$apply | [base]/ActivityDefinition/[id]/$apply
Data Requirements [base]/ActivityDefinition/[id]/$data-requirements
Fetch a subset of the CapabilityStatement resource [base]/CapabilityStatement/$subset | [base]/CapabilityStatement/[id]/$subset
Test if a server implements a client's required operations [base]/CapabilityStatement/$implements | [base]/CapabilityStatement/[id]/$implements
Test if a server implements a client's required operations [base]/CapabilityStatement/$conforms
Discover what versions a server supports [base]/$versions
Apply [base]/ChargeItemDefinition/[id]/$apply
Submit a Claim resource for adjudication [base]/Claim/$submit
Concept Look Up & Decomposition [base]/CodeSystem/$lookup | [base]/CodeSystem/[id]/$lookup
Code System based Validation [base]/CodeSystem/$validate-code | [base]/CodeSystem/[id]/$validate-code
Subsumption Testing [base]/CodeSystem/$subsumes | [base]/CodeSystem/[id]/$subsumes
Finding codes based on supplied properties [base]/CodeSystem/$find-matches | [base]/CodeSystem/[id]/$find-matches
Generate a Document [base]/Composition/[id]/$document
Concept Translation [base]/ConceptMap/$translate | [base]/ConceptMap/[id]/$translate
Closure Table Maintenance [base]/$closure
Submit an EligibilityRequest resource for assessment [base]/CoverageEligibilityRequest/$submit
Generate a DocumentReference from a document [base]/DocumentReference/$generate
Fetch DocumentReference [base]/DocumentReference/$docref
Fetch Encounter Record [base]/Encounter/[id]/$everything
Fetch EpisodeOfCare Record [base]/EpisodeOfCare/[id]/$everything
Fetch a group of Patient Records [base]/Group/[id]/$everything
Data Requirements [base]/$data-requirements | [base]/Library/[id]/$data-requirements
Find a functional list [base]/List/$find
Evaluate Measure [base]/Measure/$evaluate-measure | [base]/Measure/[id]/$evaluate-measure
Data Requirements [base]/Measure/[id]/$data-requirements
Submit Data [base]/Measure/$submit-data | [base]/Measure/[id]/$submit-data
Collect Data [base]/Measure/$collect-data | [base]/Measure/[id]/$collect-data
Care Gaps [base]/Measure/$care-gaps
Fetch Product Record [base]/MedicinalProductDefinition/$everything | [base]/MedicinalProductDefinition/[id]/$everything
Process Message [base]/$process-message
Fetch Preferred id [base]/NamingSystem/$preferred-id
Translate id [base]/NamingSystem/$translate-id
Observation Statistics [base]/Observation/$stats
Last N Observations Query [base]/Observation/$lastn
Find patient matches using MPI based logic [base]/Patient/$match
Fetch Patient Record [base]/Patient/$everything | [base]/Patient/[id]/$everything
Patient Merge [base]/Patient/$merge
Apply [base]/PlanDefinition/$apply | [base]/PlanDefinition/[id]/$apply
Data Requirements [base]/PlanDefinition/[id]/$data-requirements
Apply [base]/SpecimenDefinition/$apply | [base]/SpecimenDefinition/[id]/$apply
Build Questionnaire [base]/StructureDefinition/$questionnaire | [base]/StructureDefinition/[id]/$questionnaire
Generate Snapshot [base]/StructureDefinition/$snapshot | [base]/StructureDefinition/[id]/$snapshot
Model Instance Transformation [base]/StructureMap/$transform | [base]/StructureMap/[id]/$transform
Search and retrieve prior events for a Subscription [base]/Subscription/[id]/$events
Get Current Subscription Status for One or More Subscriptions [base]/Subscription/$status | [base]/Subscription/[id]/$status
Get a binding token for use in a websocket connection [base]/Subscription/$get-ws-binding-token | [base]/Subscription/[id]/$get-ws-binding-token
Value Set Expansion [base]/ValueSet/$expand | [base]/ValueSet/[id]/$expand
Value Set based Validation [base]/ValueSet/$validate-code | [base]/ValueSet/[id]/$validate-code

5.4.5 5.5.5 Search Parameters

Search parameters for this resource. See also the full list of search parameters for this resource , and check the Extensions registry for search parameters on extensions related to this resource. The common parameters also apply. See Searching for more information about searching in REST, messaging, and services.

Name Type Description Expression In Common
base TU reference Marks this as a profile of the base OperationDefinition.base
( OperationDefinition )
code TU token Name used to invoke the operation OperationDefinition.code
context TU token A use context assigned to the operation definition (OperationDefinition.useContext.value as CodeableConcept) (OperationDefinition.useContext.value.ofType(CodeableConcept)) 30 Resources
context-quantity TU quantity A quantity- or range-valued use context assigned to the operation definition (OperationDefinition.useContext.value as Quantity) (OperationDefinition.useContext.value.ofType(Quantity)) | (OperationDefinition.useContext.value as Range) (OperationDefinition.useContext.value.ofType(Range)) 30 Resources
context-type TU token A type of use context assigned to the operation definition OperationDefinition.useContext.code 30 Resources
context-type-quantity TU composite A use context type and quantity- or range-based value assigned to the operation definition On OperationDefinition.useContext:
  context-type: code
  context-quantity: value.as(Quantity) value.ofType(Quantity) | value.as(Range) value.ofType(Range) 		30 Resources
context-type-value TU composite A use context type and value assigned to the operation definition On OperationDefinition.useContext:
  context-type: code
  context: value.as(CodeableConcept) value.ofType(CodeableConcept) 		30 Resources
date TU date The operation definition publication date OperationDefinition.date 30 Resources
description TU string The description of the operation definition OperationDefinition.description 28 Resources
identifier token External identifier for the search parameter OperationDefinition.identifier 34 Resources
input-profile TU reference Validation information for in parameters OperationDefinition.inputProfile
( StructureDefinition )
instance TU token Invoke on an instance? OperationDefinition.instance
jurisdiction TU token Intended jurisdiction for the operation definition OperationDefinition.jurisdiction 26 Resources
kind TU token operation | query OperationDefinition.kind
name TU string Computationally friendly name of the operation definition OperationDefinition.name 26 Resources
output-profile TU reference Validation information for out parameters OperationDefinition.outputProfile
( StructureDefinition )
publisher TU string Name of the publisher of the operation definition OperationDefinition.publisher 30 Resources
status TU token The current status of the operation definition OperationDefinition.status 35 Resources
system TU token Invoke at the system level? OperationDefinition.system
title TU string The human-friendly name of the operation definition OperationDefinition.title 27 Resources
type TU token Invoke at the type level? OperationDefinition.type
url TU uri The uri that identifies the operation definition OperationDefinition.url 34 Resources
version TU token The business version of the operation definition OperationDefinition.version 30 Resources