OperationDefinition
A formal computable definition of an operation (on the RESTful interface) or a named query (using the search interaction).
Endpoints
alpha
https://api.dev.ovok.com/fhir/R4/OperationDefinition| Interaction | Method | Path |
|---|---|---|
| Read | GET | /fhir/R4/OperationDefinition/[id] |
| Vread | GET | /fhir/R4/OperationDefinition/[id]/_history/[vid] |
| Update | PUT | /fhir/R4/OperationDefinition/[id] |
| Patch | PATCH | /fhir/R4/OperationDefinition/[id] |
| Delete | DELETE | /fhir/R4/OperationDefinition/[id] |
| Create | POST | /fhir/R4/OperationDefinition |
| Search | GET | /fhir/R4/OperationDefinition |
| History | GET | /fhir/R4/OperationDefinition/[id]/_history |
Top-level elements
| Element | Type(s) | Cardinality | Description |
|---|---|---|---|
url | uri | 0..1 | Canonical identifier for this operation definition, represented as a URI (globally unique) |
version | string | 0..1 | Business version of the operation definition |
name | string | 1..1 | Name for this operation definition (computer friendly) |
title | string | 0..1 | Name for this operation definition (human friendly) |
status | code | 1..1 | draft | active | retired | unknown modifier |
kind | code | 1..1 | operation | query |
experimental | boolean | 0..1 | For testing purposes, not real usage |
date | dateTime | 0..1 | Date last changed |
publisher | string | 0..1 | Name of the publisher (organization or individual) |
contact | ContactDetail | 0..* | Contact details for the publisher |
description | markdown | 0..1 | Natural language description of the operation definition |
useContext | UsageContext | 0..* | The context that the content is intended to support |
jurisdiction | CodeableConcept | 0..* | Intended jurisdiction for operation definition (if applicable) |
purpose | markdown | 0..1 | Why this operation definition is defined |
affectsState | boolean | 0..1 | Whether content is changed by the operation |
code | code | 1..1 | Name used to invoke the operation |
comment | markdown | 0..1 | Additional information about use |
base | canonical | 0..1 | Marks this as a profile of the base |
resource | code | 0..* | Types this operation applies to |
system | boolean | 1..1 | Invoke at the system level? |
type | boolean | 1..1 | Invoke at the type level? |
instance | boolean | 1..1 | Invoke on an instance? |
inputProfile | canonical | 0..1 | Validation information for in parameters |
outputProfile | canonical | 0..1 | Validation information for out parameters |
parameter | BackboneElement | 0..* | Parameters for the operation/query |
overload | BackboneElement | 0..* | Define overloaded variants for when generating code |
Resource-specific search parameters
Reference
- Official FHIR R4 spec:
OperationDefinition - Maturity: Normative (FMM 5).