> ## Documentation Index
> Fetch the complete documentation index at: https://docs.metriport.com/llms.txt
> Use this file to discover all available pages before exploring further.

# OperationDefinition

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

## Properties

| Name                | Required | Type                                                               | Description                                                                                |
| ------------------- | -------- | ------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ |
| url                 | No       | uri                                                                | Canonical identifier for this operation definition, represented as a URI (globally unique) |
| version             | No       | string                                                             | Business version of the operation definition                                               |
| name                | Yes      | string                                                             | Name for this operation definition (computer friendly)                                     |
| title               | No       | string                                                             | Name for this operation definition (human friendly)                                        |
| status              | Yes      | code                                                               | draft / active / retired / unknown                                                         |
| kind                | Yes      | code                                                               | operation / query                                                                          |
| experimental        | No       | boolean                                                            | For testing purposes, not real usage                                                       |
| date                | No       | dateTime                                                           | Date last changed                                                                          |
| publisher           | No       | string                                                             | Name of the publisher (organization or individual)                                         |
| contact             | No       | [ContactDetail](/medical-api/fhir/data-types/contactdetail)\[]     | Contact details for the publisher                                                          |
| description         | No       | markdown                                                           | Natural language description of the operation definition                                   |
| useContext          | No       | [UsageContext](/medical-api/fhir/data-types/usagecontext)\[]       | The context that the content is intended to support                                        |
| jurisdiction        | No       | [CodeableConcept](/medical-api/fhir/data-types/codeableconcept)\[] | Intended jurisdiction for operation definition (if applicable)                             |
| purpose             | No       | markdown                                                           | Why this operation definition is defined                                                   |
| affectsState        | No       | boolean                                                            | Whether content is changed by the operation                                                |
| code                | Yes      | code                                                               | Name used to invoke the operation                                                          |
| comment             | No       | markdown                                                           | Additional information about use                                                           |
| base                | No       | canonical                                                          | Marks this as a profile of the base                                                        |
| resource            | No       | code\[]                                                            | Types this operation applies to                                                            |
| system              | Yes      | boolean                                                            | Invoke at the system level?                                                                |
| type                | Yes      | boolean                                                            | Invoke at the type level?                                                                  |
| instance            | Yes      | boolean                                                            | Invoke on an instance?                                                                     |
| inputProfile        | No       | canonical                                                          | Validation information for in parameters                                                   |
| outputProfile       | No       | canonical                                                          | Validation information for out parameters                                                  |
| parameter           | No       | OperationDefinitionParameter                                       | Parameters for the operation/query                                                         |
| - id                | No       | string                                                             | Unique id for inter-element referencing                                                    |
| - extension         | No       | [Extension](/medical-api/fhir/data-types/extension)\[]             | Additional content defined by implementations                                              |
| - modifierExtension | No       | [Extension](/medical-api/fhir/data-types/extension)\[]             | Extensions that cannot be ignored even if unrecognized                                     |
| - name              | Yes      | code                                                               | Name in Parameters.parameter.name or in URL                                                |
| - use               | Yes      | code                                                               | in / out                                                                                   |
| - min               | Yes      | integer                                                            | Minimum Cardinality                                                                        |
| - max               | Yes      | string                                                             | Maximum Cardinality (a number or \*)                                                       |
| - documentation     | No       | string                                                             | Description of meaning/use                                                                 |
| - type              | No       | code                                                               | What type this parameter has                                                               |
| - targetProfile     | No       | canonical\[]                                                       | If type is Reference / canonical, allowed targets                                          |
| - searchType        | No       | code                                                               | number / date / string / token / reference / composite / quantity / uri / special          |
| - binding           | No       | OperationDefinitionParameterBinding                                | ValueSet details if this is coded                                                          |
| - id                | No       | string                                                             | Unique id for inter-element referencing                                                    |
| - extension         | No       | [Extension](/medical-api/fhir/data-types/extension)\[]             | Additional content defined by implementations                                              |
| - modifierExtension | No       | [Extension](/medical-api/fhir/data-types/extension)\[]             | Extensions that cannot be ignored even if unrecognized                                     |
| - strength          | Yes      | code                                                               | required / extensible / preferred / example                                                |
| - valueSet          | Yes      | canonical                                                          | Source of value set                                                                        |
| - referencedFrom    | No       | OperationDefinitionParameterReferencedFrom                         | References to this parameter                                                               |
| - id                | No       | string                                                             | Unique id for inter-element referencing                                                    |
| - extension         | No       | [Extension](/medical-api/fhir/data-types/extension)\[]             | Additional content defined by implementations                                              |
| - modifierExtension | No       | [Extension](/medical-api/fhir/data-types/extension)\[]             | Extensions that cannot be ignored even if unrecognized                                     |
| - source            | Yes      | string                                                             | Referencing parameter                                                                      |
| - sourceId          | No       | string                                                             | Element id of reference                                                                    |
| - part              | No       | \[]                                                                | Parts of a nested Parameter                                                                |
| overload            | No       | OperationDefinitionOverload                                        | Define overloaded variants for when generating code                                        |
| - id                | No       | string                                                             | Unique id for inter-element referencing                                                    |
| - extension         | No       | [Extension](/medical-api/fhir/data-types/extension)\[]             | Additional content defined by implementations                                              |
| - modifierExtension | No       | [Extension](/medical-api/fhir/data-types/extension)\[]             | Extensions that cannot be ignored even if unrecognized                                     |
| - parameterName     | No       | string\[]                                                          | Name of parameter to include in overload                                                   |
| - comment           | No       | string                                                             | Comments to go on overload                                                                 |

## Search Parameters

| Name                  | Type      | Description                                                                                | Expression                           |
| --------------------- | --------- | ------------------------------------------------------------------------------------------ | ------------------------------------ |
| context               | token     | A use context assigned to the operation definition                                         | OperationDefinition.useContext.value |
| context-quantity      | quantity  | A quantity- or range-valued use context assigned to the operation definition               | OperationDefinition.useContext.value |
| context-type          | token     | A type of use context assigned to the operation definition                                 | OperationDefinition.useContext.code  |
| date                  | date      | The operation definition publication date                                                  | OperationDefinition.date             |
| description           | string    | The description of the operation definition                                                | OperationDefinition.description      |
| jurisdiction          | token     | Intended jurisdiction for the operation definition                                         | OperationDefinition.jurisdiction     |
| name                  | string    | Computationally friendly name of the operation definition                                  | OperationDefinition.name             |
| publisher             | string    | Name of the publisher of the operation definition                                          | OperationDefinition.publisher        |
| status                | token     | The current status of the operation definition                                             | OperationDefinition.status           |
| title                 | string    | The human-friendly name of the operation definition                                        | OperationDefinition.title            |
| url                   | uri       | The uri that identifies the operation definition                                           | OperationDefinition.url              |
| version               | token     | The business version of the operation definition                                           | OperationDefinition.version          |
| context-type-quantity | composite | A use context type and quantity- or range-based value assigned to the operation definition | OperationDefinition.useContext       |
| context-type-value    | composite | A use context type and value assigned to the operation definition                          | OperationDefinition.useContext       |
| base                  | reference | Marks this as a profile of the base                                                        | OperationDefinition.base             |
| code                  | token     | Name used to invoke the operation                                                          | OperationDefinition.code             |
| input-profile         | reference | Validation information for in parameters                                                   | OperationDefinition.inputProfile     |
| instance              | token     | Invoke on an instance?                                                                     | OperationDefinition.instance         |
| kind                  | token     | operation / query                                                                          | OperationDefinition.kind             |
| output-profile        | reference | Validation information for out parameters                                                  | OperationDefinition.outputProfile    |
| system                | token     | Invoke at the system level?                                                                | OperationDefinition.system           |
| type                  | token     | Invoke at the type level?                                                                  | OperationDefinition.type             |

## Inherited Properties

| Name              | Required | Type                                                   | Description                                            |
| ----------------- | -------- | ------------------------------------------------------ | ------------------------------------------------------ |
| id                | No       | string                                                 | Logical id of this artifact                            |
| meta              | No       | [Meta](/medical-api/fhir/data-types/meta)              | Metadata about the resource                            |
| implicitRules     | No       | uri                                                    | A set of rules under which this content was created    |
| language          | No       | code                                                   | Language of the resource content                       |
| text              | No       | [Narrative](/medical-api/fhir/data-types/narrative)    | Text summary of the resource, for human interpretation |
| contained         | No       | Resource\[]                                            | Contained, inline Resources                            |
| extension         | No       | [Extension](/medical-api/fhir/data-types/extension)\[] | Additional content defined by implementations          |
| modifierExtension | No       | [Extension](/medical-api/fhir/data-types/extension)\[] | Extensions that cannot be ignored                      |

To view the FHIR specification for this resource, see [OperationDefinition](https://www.hl7.org/fhir/StructureDefinition/OperationDefinition).
