http://hl7.org/fhir/StructureDefinition/OperationDefinition|4.0.1

description: A formal computable definition of an operation (on the RESTful interface) or a named query (using the search interaction).
derivation: specialization
name: OperationDefinition
type: OperationDefinition
elements:
  description: {short: Natural language description of the operation definition, index: 10}
  date: {short: Date last changed, isSummary: true, index: 7}
  system: {short: 'Invoke at the system level?', isSummary: true, index: 19}
  publisher: {short: Name of the publisher (organization or individual), isSummary: true, index: 8}
  instance: {short: 'Invoke on an instance?', isSummary: true, index: 21}
  jurisdiction:
    short: Intended jurisdiction for operation definition (if applicable)
    array: true
    binding: {strength: extensible, valueSet: 'http://hl7.org/fhir/ValueSet/jurisdiction'}
    isSummary: true
    index: 12
  purpose: {short: Why this operation definition is defined, index: 13}
  name: {short: Name for this operation definition (computer friendly), isSummary: true, index: 2}
  useContext: {short: The context that the content is intended to support, array: true, isSummary: true, index: 11}
  type: {short: 'Invoke at the type level?', isSummary: true, index: 20}
  overload:
    short: Define overloaded variants for when  generating code
    array: true
    index: 40
    elements:
      parameterName: {short: Name of parameter to include in overload, array: true, index: 41}
      comment: {short: Comments to go on overload, index: 42}
  experimental: {short: 'For testing purposes, not real usage', isSummary: true, index: 6}
  outputProfile: {short: Validation information for out parameters, index: 23}
  title: {short: Name for this operation definition (human friendly), isSummary: true, index: 3}
  status:
    isModifier: true
    short: draft | active | retired | unknown
    binding: {strength: required, valueSet: 'http://hl7.org/fhir/ValueSet/publication-status|4.0.1'}
    isModifierReason: This is labeled as \"Is Modifier\" because applications should not use a retired {{title}} without due consideration
    isSummary: true
    index: 4
  resource:
    short: Types this operation applies to
    array: true
    binding: {strength: required, valueSet: 'http://hl7.org/fhir/ValueSet/resource-types|4.0.1'}
    isSummary: true
    index: 18
  affectsState: {short: Whether content is changed by the operation, isSummary: true, index: 14}
  kind:
    short: operation | query
    binding: {strength: required, valueSet: 'http://hl7.org/fhir/ValueSet/operation-kind|4.0.1'}
    isSummary: true
    index: 5
  comment: {short: Additional information about use, index: 16}
  url: {short: 'Canonical identifier for this operation definition, represented as a URI (globally unique)', isSummary: true, index: 0}
  code: {short: Name used to invoke the operation, isSummary: true, index: 15}
  base: {short: Marks this as a profile of the base, isSummary: true, index: 17}
  version: {short: Business version of the operation definition, isSummary: true, index: 1}
  contact: {short: Contact details for the publisher, array: true, isSummary: true, index: 9}
  inputProfile: {short: Validation information for in parameters, index: 22}
  parameter:
    constraint:
      opd-1: {human: 'Either a type must be provided, or parts', severity: error, expression: type.exists() or part.exists()}
      opd-2: {human: A search type can only be specified for parameters of type string, severity: error, expression: searchType.exists() implies type = 'string'}
      opd-3: {human: A targetProfile can only be specified for parameters of type Reference or Canonical, severity: error, expression: targetProfile.exists() implies (type = 'Reference' or type = 'canonical')}
    short: Parameters for the operation/query
    array: true
    index: 24
    elements:
      min: {short: Minimum Cardinality, index: 27}
      searchType:
        short: number | date | string | token | reference | composite | quantity | uri | special
        binding: {strength: required, valueSet: 'http://hl7.org/fhir/ValueSet/search-param-type|4.0.1'}
        index: 32
      use:
        short: in | out
        binding: {strength: required, valueSet: 'http://hl7.org/fhir/ValueSet/operation-parameter-use|4.0.1'}
        index: 26
      name: {short: Name in Parameters.parameter.name or in URL, index: 25}
      part:
        elementReference: ['http://hl7.org/fhir/StructureDefinition/OperationDefinition', elements, parameter]
        short: Parts of a nested Parameter
        array: true
        index: 39
      type:
        short: What type this parameter has
        binding: {strength: required, valueSet: 'http://hl7.org/fhir/ValueSet/all-types|4.0.1'}
        index: 30
      referencedFrom:
        short: References to this parameter
        array: true
        index: 36
        elements:
          source: {short: Referencing parameter, index: 37}
          sourceId: {short: Element id of reference, index: 38}
        required: [source]
      documentation: {short: Description of meaning/use, index: 29}
      binding:
        short: ValueSet details if this is coded
        index: 33
        elements:
          strength:
            short: required | extensible | preferred | example
            binding: {strength: required, valueSet: 'http://hl7.org/fhir/ValueSet/binding-strength|4.0.1'}
            index: 34
          valueSet: {short: Source of value set, index: 35}
        required: [valueSet, strength]
      max: {short: Maximum Cardinality (a number or *), index: 28}
      targetProfile: {short: 'If type is Reference | canonical, allowed targets', array: true, index: 31}
    required: [min, max, name, use]
class: resource
kind: resource
url: http://hl7.org/fhir/StructureDefinition/OperationDefinition
base: http://hl7.org/fhir/StructureDefinition/DomainResource
version: 4.0.1
required: [name, status, instance, kind, type, system, code]