Release 4B Snapshot #1

This page is part of the FHIR Specification v4.3.0-snapshot1: R4B Snapshot to support the Jan 2022 Connectathon. About the R4B version of FHIR. The current officially released version is 4.3.0. For a full list of available versions, see the Directory of published versions . Page versions: R5 R4B R4 R3 R2

5.4 Resource OperationDefinition - Content

FHIR Infrastructure Work GroupMaturity Level: N Normative (from v4.0.0)Security Category: Anonymous Compartments: Not linked to any 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 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 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

5.4.3 References

This resource is referenced by CapabilityStatement, CarePlan, Communication, FamilyMemberHistory, itself and Procedure.

This resource implements the Definition pattern.

5.4.4 Resource Content

Structure

NameFlagsCard.TypeDescription & Constraintsdoco
.. OperationDefinition NDomainResourceDefinition 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
Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension
... url Σ0..1uriCanonical identifier for this operation definition, represented as a URI (globally unique)
... version Σ0..1stringBusiness version of the operation definition
... name Σ1..1stringName for this operation definition (computer friendly)
... status ?!Σ1..1codedraft | active | retired | unknown
PublicationStatus (Required)
... kind Σ1..1codeoperation | query
OperationKind (Required)
... experimental Σ0..1booleanFor testing purposes, not real usage
... date Σ0..1dateTimeDate last changed
... publisher Σ0..1stringName of the publisher (organization or individual)
... contact Σ0..*ContactDetailContact details for the publisher
... description 0..1markdownNatural language description of the operation definition
... useContext ΣTU0..*UsageContextThe context that the content is intended to support
... jurisdiction Σ0..*CodeableConceptIntended jurisdiction for operation definition (if applicable)
Jurisdiction (Extensible)
... purpose 0..1markdownWhy this operation definition is defined
... affectsState Σ0..1booleanWhether content is changed by the operation
... code Σ1..1codeName used to invoke the operation
... comment 0..1markdownAdditional information about use
... base Σ0..1canonical(OperationDefinition)Marks this as a profile of the base
... resource Σ0..*codeTypes this operation applies to
ResourceType (Required)
... system Σ1..1booleanInvoke at the system level?
... type Σ1..1booleanInvoke at the type level?
... instance Σ1..1booleanInvoke on an instance?
... inputProfile 0..1canonical(StructureDefinition)Validation information for in parameters
... outputProfile 0..1canonical(StructureDefinition)Validation information for out parameters
... parameter I0..*BackboneElementParameters 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 or Canonical
.... name 1..1codeName in Parameters.parameter.name or in URL
.... use 1..1codein | out
OperationParameterUse (Required)
.... min 1..1integerMinimum Cardinality
.... max 1..1stringMaximum Cardinality (a number or *)
.... documentation 0..1stringDescription of meaning/use
.... type I0..1codeWhat type this parameter has
FHIRAllTypes (Required)
.... targetProfile 0..*canonical(StructureDefinition)If type is Reference | canonical, allowed targets
.... searchType I0..1codenumber | date | string | token | reference | composite | quantity | uri | special
SearchParamType (Required)
.... binding 0..1BackboneElementValueSet details if this is coded
..... strength 1..1coderequired | extensible | preferred | example
BindingStrength (Required)
..... valueSet 1..1canonical(ValueSet)Source of value set
.... referencedFrom TU0..*BackboneElementReferences to this parameter
..... source 1..1stringReferencing parameter
..... sourceId 0..1stringElement id of reference
.... part I0..*see parameterParts of a nested Parameter
... overload 0..*BackboneElementDefine overloaded variants for when generating code
.... parameterName 0..*stringName of parameter to include in overload
.... comment 0..1stringComments to go on overload

doco Documentation for this format

UML Diagram (Legend)

OperationDefinition (DomainResource)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 serversurl : uri [0..1]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 sequenceversion : string [0..1]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 generationname : string [1..1]A short, descriptive, user-friendly title for the operation definitiontitle : string [0..1]The status of this operation definition. Enables tracking the life-cycle of the content (this element modifies the meaning of other elements)status : code [1..1] « null (Strength=Required)PublicationStatus! »Whether this is an operation or a named querykind : code [1..1] « null (Strength=Required)OperationKind! »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 usageexperimental : boolean [0..1]The date (and optionally time) when the operation definition was published. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the operation definition changesdate : dateTime [0..1]The name of the organization or individual that published the operation definitionpublisher : string [0..1]Contact details to assist a user in finding and communicating with the publishercontact : ContactDetail [0..*]A free text natural language description of the operation definition from a consumer's perspectivedescription : 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 instancesuseContext : UsageContext [0..*]A legal or geographic region in which the operation definition is intended to be usedjurisdiction : CodeableConcept [0..*] « null (Strength=Extensible)Jurisdiction ValueSet+ »Explanation of why this operation definition is needed and why it has been designed as it haspurpose : markdown [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 used to invoke the operationcode : code [1..1]Additional information about how to use this operation or named querycomment : markdown [0..1]Indicates that this operation definition is a constraining profile on the basebase : canonical [0..1] « OperationDefinition »The types on which this operation can be executedresource : code [0..*] « null (Strength=Required)ResourceType! »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 typesinstance : boolean [1..1]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 wholeinputProfile : 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 resourceoutputProfile : canonical [0..1] « StructureDefinition »ParameterThe name of used to identify the parametername : code [1..1]Whether this is an input or an output parameteruse : code [1..1] « null (Strength=Required)OperationParameterUse! »The minimum number of times this parameter SHALL appear in the request or responsemin : integer [1..1]The maximum number of times this element is permitted to appear in the request or responsemax : string [1..1]Describes the meaning or use of this parameterdocumentation : string [0..1]The type for this parametertype : code [0..1] « null (Strength=Required)FHIRAllTypes! »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 guidetargetProfile : canonical [0..*] « StructureDefinition »How the parameter is understood as a search parameter. This is only used if the parameter type is 'string'searchType : code [0..1] « null (Strength=Required)SearchParamType! »BindingIndicates 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 instancesstrength : 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 usedvalueSet : canonical [1..1] « ValueSet »ReferencedFromThe 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 resourcesource : string [1..1]The id of the element in the referencing resource that is expected to resolve to this resourcesourceId : string [0..1]OverloadName of parameter to include in overloadparameterName : string [0..*]Comments to go on overloadcomment : 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 resourcereferencedFrom[0..*]The parts of a nested Parameterpart[0..*]The parameters for the operation/queryparameter[0..*]Defines an appropriate combination of parameters to use when invoking this operation, to help code generators when generating overloaded parameter sets for this operationoverload[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 a URI (globally unique) -->
 <version value="[string]"/><!-- 0..1 Business version of the operation definition -->
 <name value="[string]"/><!-- 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]"/><!-- 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 (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><!-- 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 -->
 <affectsState value="[boolean]"/><!-- 0..1 Whether content is changed by the operation -->
 <code value="[code]"/><!-- 1..1 Name used to invoke the operation -->
 <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]"/><!-- 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>  <!-- 0..* Parameters for the operation/query -->
  <name value="[code]"/><!-- 1..1 Name in Parameters.parameter.name or in URL -->
  <use value="[code]"/><!-- 1..1 in | out -->
  <min value="[integer]"/><!-- 1..1 Minimum Cardinality -->
  <max value="[string]"/><!-- 1..1 Maximum Cardinality (a number or *) -->
  <documentation value="[string]"/><!-- 0..1 Description of meaning/use -->
  <type value="[code]"/><!-- ?? 0..1 What type this parameter has -->
  <targetProfile><!-- 0..* canonical(StructureDefinition) If type is Reference | canonical, allowed targets --></targetProfile>
  <searchType value="[code]"/><!-- ?? 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><!-- ?? 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 a URI (globally unique)
  "version" : "<string>", // Business version of the operation definition
  "name" : "<string>", // 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>", // R!  operation | query
  "experimental" : <boolean>, // For testing purposes, not real usage
  "date" : "<dateTime>", // Date last changed
  "publisher" : "<string>", // Name of the publisher (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
  "affectsState" : <boolean>, // Whether content is changed by the operation
  "code" : "<code>", // R!  Name used to invoke the operation
  "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>, // R!  Invoke on an instance?
  "inputProfile" : { canonical(StructureDefinition) }, // Validation information for in parameters
  "outputProfile" : { canonical(StructureDefinition) }, // Validation information for out parameters
  "parameter" : [{ // Parameters for the operation/query
    "name" : "<code>", // R!  Name in Parameters.parameter.name or in URL
    "use" : "<code>", // R!  in | out
    "min" : <integer>, // R!  Minimum Cardinality
    "max" : "<string>", // R!  Maximum Cardinality (a number or *)
    "documentation" : "<string>", // Description of meaning/use
    "type" : "<code>", // C? What type this parameter has
    "targetProfile" : [{ canonical(StructureDefinition) }], // If type is Reference | canonical, allowed targets
    "searchType" : "<code>", // C? 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 }] // C? 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:OperationDefinition.url [ uri ]; # 0..1 Canonical identifier for this operation definition, represented as a URI (globally unique)
  fhir:OperationDefinition.version [ string ]; # 0..1 Business version of the operation definition
  fhir:OperationDefinition.name [ string ]; # 1..1 Name for this operation definition (computer friendly)
  fhir:OperationDefinition.title [ string ]; # 0..1 Name for this operation definition (human friendly)
  fhir:OperationDefinition.status [ code ]; # 1..1 draft | active | retired | unknown
  fhir:OperationDefinition.kind [ code ]; # 1..1 operation | query
  fhir:OperationDefinition.experimental [ boolean ]; # 0..1 For testing purposes, not real usage
  fhir:OperationDefinition.date [ dateTime ]; # 0..1 Date last changed
  fhir:OperationDefinition.publisher [ string ]; # 0..1 Name of the publisher (organization or individual)
  fhir:OperationDefinition.contact [ ContactDetail ], ... ; # 0..* Contact details for the publisher
  fhir:OperationDefinition.description [ markdown ]; # 0..1 Natural language description of the operation definition
  fhir:OperationDefinition.useContext [ UsageContext ], ... ; # 0..* The context that the content is intended to support
  fhir:OperationDefinition.jurisdiction [ CodeableConcept ], ... ; # 0..* Intended jurisdiction for operation definition (if applicable)
  fhir:OperationDefinition.purpose [ markdown ]; # 0..1 Why this operation definition is defined
  fhir:OperationDefinition.affectsState [ boolean ]; # 0..1 Whether content is changed by the operation
  fhir:OperationDefinition.code [ code ]; # 1..1 Name used to invoke the operation
  fhir:OperationDefinition.comment [ markdown ]; # 0..1 Additional information about use
  fhir:OperationDefinition.base [ canonical(OperationDefinition) ]; # 0..1 Marks this as a profile of the base
  fhir:OperationDefinition.resource [ code ], ... ; # 0..* Types this operation applies to
  fhir:OperationDefinition.system [ boolean ]; # 1..1 Invoke at the system level?
  fhir:OperationDefinition.type [ boolean ]; # 1..1 Invoke at the type level?
  fhir:OperationDefinition.instance [ boolean ]; # 1..1 Invoke on an instance?
  fhir:OperationDefinition.inputProfile [ canonical(StructureDefinition) ]; # 0..1 Validation information for in parameters
  fhir:OperationDefinition.outputProfile [ canonical(StructureDefinition) ]; # 0..1 Validation information for out parameters
  fhir:OperationDefinition.parameter [ # 0..* Parameters for the operation/query
    fhir:OperationDefinition.parameter.name [ code ]; # 1..1 Name in Parameters.parameter.name or in URL
    fhir:OperationDefinition.parameter.use [ code ]; # 1..1 in | out
    fhir:OperationDefinition.parameter.min [ integer ]; # 1..1 Minimum Cardinality
    fhir:OperationDefinition.parameter.max [ string ]; # 1..1 Maximum Cardinality (a number or *)
    fhir:OperationDefinition.parameter.documentation [ string ]; # 0..1 Description of meaning/use
    fhir:OperationDefinition.parameter.type [ code ]; # 0..1 What type this parameter has
    fhir:OperationDefinition.parameter.targetProfile [ canonical(StructureDefinition) ], ... ; # 0..* If type is Reference | canonical, allowed targets
    fhir:OperationDefinition.parameter.searchType [ code ]; # 0..1 number | date | string | token | reference | composite | quantity | uri | special
    fhir:OperationDefinition.parameter.binding [ # 0..1 ValueSet details if this is coded
      fhir:OperationDefinition.parameter.binding.strength [ code ]; # 1..1 required | extensible | preferred | example
      fhir:OperationDefinition.parameter.binding.valueSet [ canonical(ValueSet) ]; # 1..1 Source of value set
    ];
    fhir:OperationDefinition.parameter.referencedFrom [ # 0..* References to this parameter
      fhir:OperationDefinition.parameter.referencedFrom.source [ string ]; # 1..1 Referencing parameter
      fhir:OperationDefinition.parameter.referencedFrom.sourceId [ string ]; # 0..1 Element id of reference
    ], ...;
    fhir:OperationDefinition.parameter.part [ See OperationDefinition.parameter ], ... ; # 0..* Parts of a nested Parameter
  ], ...;
  fhir:OperationDefinition.overload [ # 0..* Define overloaded variants for when  generating code
    fhir:OperationDefinition.overload.parameterName [ string ], ... ; # 0..* Name of parameter to include in overload
    fhir:OperationDefinition.overload.comment [ string ]; # 0..1 Comments to go on overload
  ], ...;
]

Changes since R3

OperationDefinition
OperationDefinition.status
  • Change value set from http://hl7.org/fhir/ValueSet/publication-status|4.0.0 to http://hl7.org/fhir/ValueSet/publication-status|4.3.0-snapshot1
OperationDefinition.kind
  • Change value set from http://hl7.org/fhir/ValueSet/operation-kind|4.0.0 to http://hl7.org/fhir/ValueSet/operation-kind|4.3.0-snapshot1
OperationDefinition.resource
  • Change value set from http://hl7.org/fhir/ValueSet/resource-types|4.0.0 to http://hl7.org/fhir/ValueSet/resource-types|4.3.0-snapshot1
OperationDefinition.parameter.use
  • Change value set from http://hl7.org/fhir/ValueSet/operation-parameter-use|4.0.0 to http://hl7.org/fhir/ValueSet/operation-parameter-use|4.3.0-snapshot1
OperationDefinition.parameter.type
  • Change value set from http://hl7.org/fhir/ValueSet/all-types|4.0.0 to http://hl7.org/fhir/ValueSet/all-types|4.3.0-snapshot1
OperationDefinition.parameter.searchType
  • Change value set from http://hl7.org/fhir/ValueSet/search-param-type|4.0.0 to http://hl7.org/fhir/ValueSet/search-param-type|4.3.0-snapshot1
OperationDefinition.parameter.binding.strength
  • Change value set from http://hl7.org/fhir/ValueSet/binding-strength|4.0.0 to http://hl7.org/fhir/ValueSet/binding-strength|4.3.0-snapshot1

See the Full Difference for further information

This analysis is available as XML or JSON.

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

Structure

NameFlagsCard.TypeDescription & Constraintsdoco
.. OperationDefinition NDomainResourceDefinition 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
Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension
... url Σ0..1uriCanonical identifier for this operation definition, represented as a URI (globally unique)
... version Σ0..1stringBusiness version of the operation definition
... name Σ1..1stringName for this operation definition (computer friendly)
... status ?!Σ1..1codedraft | active | retired | unknown
PublicationStatus (Required)
... kind Σ1..1codeoperation | query
OperationKind (Required)
... experimental Σ0..1booleanFor testing purposes, not real usage
... date Σ0..1dateTimeDate last changed
... publisher Σ0..1stringName of the publisher (organization or individual)
... contact Σ0..*ContactDetailContact details for the publisher
... description 0..1markdownNatural language description of the operation definition
... useContext ΣTU0..*UsageContextThe context that the content is intended to support
... jurisdiction Σ0..*CodeableConceptIntended jurisdiction for operation definition (if applicable)
Jurisdiction (Extensible)
... purpose 0..1markdownWhy this operation definition is defined
... affectsState Σ0..1booleanWhether content is changed by the operation
... code Σ1..1codeName used to invoke the operation
... comment 0..1markdownAdditional information about use
... base Σ0..1canonical(OperationDefinition)Marks this as a profile of the base
... resource Σ0..*codeTypes this operation applies to
ResourceType (Required)
... system Σ1..1booleanInvoke at the system level?
... type Σ1..1booleanInvoke at the type level?
... instance Σ1..1booleanInvoke on an instance?
... inputProfile 0..1canonical(StructureDefinition)Validation information for in parameters
... outputProfile 0..1canonical(StructureDefinition)Validation information for out parameters
... parameter I0..*BackboneElementParameters 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 or Canonical
.... name 1..1codeName in Parameters.parameter.name or in URL
.... use 1..1codein | out
OperationParameterUse (Required)
.... min 1..1integerMinimum Cardinality
.... max 1..1stringMaximum Cardinality (a number or *)
.... documentation 0..1stringDescription of meaning/use
.... type I0..1codeWhat type this parameter has
FHIRAllTypes (Required)
.... targetProfile 0..*canonical(StructureDefinition)If type is Reference | canonical, allowed targets
.... searchType I0..1codenumber | date | string | token | reference | composite | quantity | uri | special
SearchParamType (Required)
.... binding 0..1BackboneElementValueSet details if this is coded
..... strength 1..1coderequired | extensible | preferred | example
BindingStrength (Required)
..... valueSet 1..1canonical(ValueSet)Source of value set
.... referencedFrom TU0..*BackboneElementReferences to this parameter
..... source 1..1stringReferencing parameter
..... sourceId 0..1stringElement id of reference
.... part I0..*see parameterParts of a nested Parameter
... overload 0..*BackboneElementDefine overloaded variants for when generating code
.... parameterName 0..*stringName of parameter to include in overload
.... comment 0..1stringComments to go on overload

doco Documentation for this format

UML Diagram (Legend)

OperationDefinition (DomainResource)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 serversurl : uri [0..1]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 sequenceversion : string [0..1]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 generationname : string [1..1]A short, descriptive, user-friendly title for the operation definitiontitle : string [0..1]The status of this operation definition. Enables tracking the life-cycle of the content (this element modifies the meaning of other elements)status : code [1..1] « null (Strength=Required)PublicationStatus! »Whether this is an operation or a named querykind : code [1..1] « null (Strength=Required)OperationKind! »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 usageexperimental : boolean [0..1]The date (and optionally time) when the operation definition was published. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the operation definition changesdate : dateTime [0..1]The name of the organization or individual that published the operation definitionpublisher : string [0..1]Contact details to assist a user in finding and communicating with the publishercontact : ContactDetail [0..*]A free text natural language description of the operation definition from a consumer's perspectivedescription : 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 instancesuseContext : UsageContext [0..*]A legal or geographic region in which the operation definition is intended to be usedjurisdiction : CodeableConcept [0..*] « null (Strength=Extensible)Jurisdiction ValueSet+ »Explanation of why this operation definition is needed and why it has been designed as it haspurpose : markdown [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 used to invoke the operationcode : code [1..1]Additional information about how to use this operation or named querycomment : markdown [0..1]Indicates that this operation definition is a constraining profile on the basebase : canonical [0..1] « OperationDefinition »The types on which this operation can be executedresource : code [0..*] « null (Strength=Required)ResourceType! »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 typesinstance : boolean [1..1]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 wholeinputProfile : 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 resourceoutputProfile : canonical [0..1] « StructureDefinition »ParameterThe name of used to identify the parametername : code [1..1]Whether this is an input or an output parameteruse : code [1..1] « null (Strength=Required)OperationParameterUse! »The minimum number of times this parameter SHALL appear in the request or responsemin : integer [1..1]The maximum number of times this element is permitted to appear in the request or responsemax : string [1..1]Describes the meaning or use of this parameterdocumentation : string [0..1]The type for this parametertype : code [0..1] « null (Strength=Required)FHIRAllTypes! »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 guidetargetProfile : canonical [0..*] « StructureDefinition »How the parameter is understood as a search parameter. This is only used if the parameter type is 'string'searchType : code [0..1] « null (Strength=Required)SearchParamType! »BindingIndicates 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 instancesstrength : 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 usedvalueSet : canonical [1..1] « ValueSet »ReferencedFromThe 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 resourcesource : string [1..1]The id of the element in the referencing resource that is expected to resolve to this resourcesourceId : string [0..1]OverloadName of parameter to include in overloadparameterName : string [0..*]Comments to go on overloadcomment : 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 resourcereferencedFrom[0..*]The parts of a nested Parameterpart[0..*]The parameters for the operation/queryparameter[0..*]Defines an appropriate combination of parameters to use when invoking this operation, to help code generators when generating overloaded parameter sets for this operationoverload[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 a URI (globally unique) -->
 <version value="[string]"/><!-- 0..1 Business version of the operation definition -->
 <name value="[string]"/><!-- 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]"/><!-- 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 (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><!-- 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 -->
 <affectsState value="[boolean]"/><!-- 0..1 Whether content is changed by the operation -->
 <code value="[code]"/><!-- 1..1 Name used to invoke the operation -->
 <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]"/><!-- 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>  <!-- 0..* Parameters for the operation/query -->
  <name value="[code]"/><!-- 1..1 Name in Parameters.parameter.name or in URL -->
  <use value="[code]"/><!-- 1..1 in | out -->
  <min value="[integer]"/><!-- 1..1 Minimum Cardinality -->
  <max value="[string]"/><!-- 1..1 Maximum Cardinality (a number or *) -->
  <documentation value="[string]"/><!-- 0..1 Description of meaning/use -->
  <type value="[code]"/><!-- ?? 0..1 What type this parameter has -->
  <targetProfile><!-- 0..* canonical(StructureDefinition) If type is Reference | canonical, allowed targets --></targetProfile>
  <searchType value="[code]"/><!-- ?? 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><!-- ?? 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 a URI (globally unique)
  "version" : "<string>", // Business version of the operation definition
  "name" : "<string>", // 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>", // R!  operation | query
  "experimental" : <boolean>, // For testing purposes, not real usage
  "date" : "<dateTime>", // Date last changed
  "publisher" : "<string>", // Name of the publisher (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
  "affectsState" : <boolean>, // Whether content is changed by the operation
  "code" : "<code>", // R!  Name used to invoke the operation
  "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>, // R!  Invoke on an instance?
  "inputProfile" : { canonical(StructureDefinition) }, // Validation information for in parameters
  "outputProfile" : { canonical(StructureDefinition) }, // Validation information for out parameters
  "parameter" : [{ // Parameters for the operation/query
    "name" : "<code>", // R!  Name in Parameters.parameter.name or in URL
    "use" : "<code>", // R!  in | out
    "min" : <integer>, // R!  Minimum Cardinality
    "max" : "<string>", // R!  Maximum Cardinality (a number or *)
    "documentation" : "<string>", // Description of meaning/use
    "type" : "<code>", // C? What type this parameter has
    "targetProfile" : [{ canonical(StructureDefinition) }], // If type is Reference | canonical, allowed targets
    "searchType" : "<code>", // C? 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 }] // C? 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:OperationDefinition.url [ uri ]; # 0..1 Canonical identifier for this operation definition, represented as a URI (globally unique)
  fhir:OperationDefinition.version [ string ]; # 0..1 Business version of the operation definition
  fhir:OperationDefinition.name [ string ]; # 1..1 Name for this operation definition (computer friendly)
  fhir:OperationDefinition.title [ string ]; # 0..1 Name for this operation definition (human friendly)
  fhir:OperationDefinition.status [ code ]; # 1..1 draft | active | retired | unknown
  fhir:OperationDefinition.kind [ code ]; # 1..1 operation | query
  fhir:OperationDefinition.experimental [ boolean ]; # 0..1 For testing purposes, not real usage
  fhir:OperationDefinition.date [ dateTime ]; # 0..1 Date last changed
  fhir:OperationDefinition.publisher [ string ]; # 0..1 Name of the publisher (organization or individual)
  fhir:OperationDefinition.contact [ ContactDetail ], ... ; # 0..* Contact details for the publisher
  fhir:OperationDefinition.description [ markdown ]; # 0..1 Natural language description of the operation definition
  fhir:OperationDefinition.useContext [ UsageContext ], ... ; # 0..* The context that the content is intended to support
  fhir:OperationDefinition.jurisdiction [ CodeableConcept ], ... ; # 0..* Intended jurisdiction for operation definition (if applicable)
  fhir:OperationDefinition.purpose [ markdown ]; # 0..1 Why this operation definition is defined
  fhir:OperationDefinition.affectsState [ boolean ]; # 0..1 Whether content is changed by the operation
  fhir:OperationDefinition.code [ code ]; # 1..1 Name used to invoke the operation
  fhir:OperationDefinition.comment [ markdown ]; # 0..1 Additional information about use
  fhir:OperationDefinition.base [ canonical(OperationDefinition) ]; # 0..1 Marks this as a profile of the base
  fhir:OperationDefinition.resource [ code ], ... ; # 0..* Types this operation applies to
  fhir:OperationDefinition.system [ boolean ]; # 1..1 Invoke at the system level?
  fhir:OperationDefinition.type [ boolean ]; # 1..1 Invoke at the type level?
  fhir:OperationDefinition.instance [ boolean ]; # 1..1 Invoke on an instance?
  fhir:OperationDefinition.inputProfile [ canonical(StructureDefinition) ]; # 0..1 Validation information for in parameters
  fhir:OperationDefinition.outputProfile [ canonical(StructureDefinition) ]; # 0..1 Validation information for out parameters
  fhir:OperationDefinition.parameter [ # 0..* Parameters for the operation/query
    fhir:OperationDefinition.parameter.name [ code ]; # 1..1 Name in Parameters.parameter.name or in URL
    fhir:OperationDefinition.parameter.use [ code ]; # 1..1 in | out
    fhir:OperationDefinition.parameter.min [ integer ]; # 1..1 Minimum Cardinality
    fhir:OperationDefinition.parameter.max [ string ]; # 1..1 Maximum Cardinality (a number or *)
    fhir:OperationDefinition.parameter.documentation [ string ]; # 0..1 Description of meaning/use
    fhir:OperationDefinition.parameter.type [ code ]; # 0..1 What type this parameter has
    fhir:OperationDefinition.parameter.targetProfile [ canonical(StructureDefinition) ], ... ; # 0..* If type is Reference | canonical, allowed targets
    fhir:OperationDefinition.parameter.searchType [ code ]; # 0..1 number | date | string | token | reference | composite | quantity | uri | special
    fhir:OperationDefinition.parameter.binding [ # 0..1 ValueSet details if this is coded
      fhir:OperationDefinition.parameter.binding.strength [ code ]; # 1..1 required | extensible | preferred | example
      fhir:OperationDefinition.parameter.binding.valueSet [ canonical(ValueSet) ]; # 1..1 Source of value set
    ];
    fhir:OperationDefinition.parameter.referencedFrom [ # 0..* References to this parameter
      fhir:OperationDefinition.parameter.referencedFrom.source [ string ]; # 1..1 Referencing parameter
      fhir:OperationDefinition.parameter.referencedFrom.sourceId [ string ]; # 0..1 Element id of reference
    ], ...;
    fhir:OperationDefinition.parameter.part [ See OperationDefinition.parameter ], ... ; # 0..* Parts of a nested Parameter
  ], ...;
  fhir:OperationDefinition.overload [ # 0..* Define overloaded variants for when  generating code
    fhir:OperationDefinition.overload.parameterName [ string ], ... ; # 0..* Name of parameter to include in overload
    fhir:OperationDefinition.overload.comment [ string ]; # 0..1 Comments to go on overload
  ], ...;
]

Changes since Release 3

OperationDefinition
OperationDefinition.status
  • Change value set from http://hl7.org/fhir/ValueSet/publication-status|4.0.0 to http://hl7.org/fhir/ValueSet/publication-status|4.3.0-snapshot1
OperationDefinition.kind
  • Change value set from http://hl7.org/fhir/ValueSet/operation-kind|4.0.0 to http://hl7.org/fhir/ValueSet/operation-kind|4.3.0-snapshot1
OperationDefinition.resource
  • Change value set from http://hl7.org/fhir/ValueSet/resource-types|4.0.0 to http://hl7.org/fhir/ValueSet/resource-types|4.3.0-snapshot1
OperationDefinition.parameter.use
  • Change value set from http://hl7.org/fhir/ValueSet/operation-parameter-use|4.0.0 to http://hl7.org/fhir/ValueSet/operation-parameter-use|4.3.0-snapshot1
OperationDefinition.parameter.type
  • Change value set from http://hl7.org/fhir/ValueSet/all-types|4.0.0 to http://hl7.org/fhir/ValueSet/all-types|4.3.0-snapshot1
OperationDefinition.parameter.searchType
  • Change value set from http://hl7.org/fhir/ValueSet/search-param-type|4.0.0 to http://hl7.org/fhir/ValueSet/search-param-type|4.3.0-snapshot1
OperationDefinition.parameter.binding.strength
  • Change value set from http://hl7.org/fhir/ValueSet/binding-strength|4.0.0 to http://hl7.org/fhir/ValueSet/binding-strength|4.3.0-snapshot1

See the Full Difference for further information

This analysis is available as XML or JSON.

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

 

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

5.4.4.1 Terminology Bindings

PathDefinitionTypeReference
OperationDefinition.status RequiredPublicationStatus
OperationDefinition.kind RequiredOperationKind
OperationDefinition.jurisdiction ExtensibleJurisdiction ValueSet
OperationDefinition.resource RequiredResourceType
OperationDefinition.parameter.use RequiredOperationParameterUse
OperationDefinition.parameter.type RequiredFHIRAllTypes
OperationDefinition.parameter.searchType RequiredSearchParamType
OperationDefinition.parameter.binding.strength RequiredBindingStrength

5.4.4.2 Constraints

idLevelLocationDescriptionExpression
opd-0Warning (base)Name should be usable as an identifier for the module by machine processing applications such as code generationname.matches('[A-Z]([A-Za-z0-9_]){0,254}')
opd-1Rule OperationDefinition.parameterEither a type must be provided, or partstype.exists() or part.exists()
opd-2Rule OperationDefinition.parameterA search type can only be specified for parameters of type stringsearchType.exists() implies type = 'string'
opd-3Rule OperationDefinition.parameterA targetProfile can only be specified for parameters of type Reference or CanonicaltargetProfile.exists() implies (type = 'Reference' or type = 'canonical')

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
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
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
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/$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
Fetch Encounter Record[base]/Encounter/[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 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
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
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.4.4 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:
NameCardinalityTypeBindingProfileDocumentation
a0..1integer

An integer parameter

b0..1Patient

A patient parameter

Out Parameters:
NameCardinalityTypeBindingProfileDocumentation
c1..1decimal

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 ) from parsing and interpreting the profile.

5.4.4.5 Executing Operations

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

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

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 a set of resources, so all the out parameters must be resources, not data types.

For named queries, all the standard search parameters are automatically in scope (though servers do not need to support them unless explicitly documented).

5.4.4.7 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>
    </resource>
  </parameter>

or, in JSON: 

 "parameter": [
    {
      "name": "valueset",
      "resource": {
        "resourceType": "ValueSet",
        // 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 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 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.4.5 Search Parameters

Search parameters for this resource. The common parameters also apply. See Searching for more information about searching in REST, messaging, and services.

NameTypeDescriptionExpressionIn Common
base TUreferenceMarks this as a profile of the baseOperationDefinition.base
(OperationDefinition)
code TUtokenName used to invoke the operationOperationDefinition.code
context TUtokenA use context assigned to the operation definition(OperationDefinition.useContext.value as CodeableConcept)
context-quantity TUquantityA quantity- or range-valued use context assigned to the operation definition(OperationDefinition.useContext.value as Quantity) | (OperationDefinition.useContext.value as Range)
context-type TUtokenA type of use context assigned to the operation definitionOperationDefinition.useContext.code
context-type-quantity TUcompositeA use context type and quantity- or range-based value assigned to the operation definitionOn OperationDefinition.useContext:
  context-type: code
  context-quantity: value.as(Quantity) | value.as(Range)
context-type-value TUcompositeA use context type and value assigned to the operation definitionOn OperationDefinition.useContext:
  context-type: code
  context: value.as(CodeableConcept)
date TUdateThe operation definition publication dateOperationDefinition.date
description TUstringThe description of the operation definitionOperationDefinition.description
input-profile TUreferenceValidation information for in parametersOperationDefinition.inputProfile
(StructureDefinition)
instance TUtokenInvoke on an instance?OperationDefinition.instance
jurisdiction TUtokenIntended jurisdiction for the operation definitionOperationDefinition.jurisdiction
kind TUtokenoperation | queryOperationDefinition.kind
name TUstringComputationally friendly name of the operation definitionOperationDefinition.name
output-profile TUreferenceValidation information for out parametersOperationDefinition.outputProfile
(StructureDefinition)
publisher TUstringName of the publisher of the operation definitionOperationDefinition.publisher
status TUtokenThe current status of the operation definitionOperationDefinition.status
system TUtokenInvoke at the system level?OperationDefinition.system
title TUstringThe human-friendly name of the operation definitionOperationDefinition.title
type TUtokenInvoke at the type level?OperationDefinition.type
url TUuriThe uri that identifies the operation definitionOperationDefinition.url
version TUtokenThe business version of the operation definitionOperationDefinition.version