OperationDefinition
OperationDefinition
activeResource70 elementsv5.0.0
A formal computable definition of an operation (on the RESTful interface) or a named query (using the search interaction).
Metadata
hl7.org/fhir- Canonical URL
- http://hl7.org/fhir/StructureDefinition/OperationDefinition
- ID
- OperationDefinition
- Type
- Base Definition
- Derivation
- specialization
- Publisher
- Health Level Seven International (FHIR Infrastructure)
- Version
- 5.0.0
| Path | Card. | Type | Description |
|---|---|---|---|
OperationDefinition | 0..* | Definition of an operation or a named query | |
id | 0..1 | string | Logical id of this artifact |
meta | 0..1 | Metadata about the resource | |
implicitRules | 0..1 | uri | A set of rules under which this content was created |
language | 0..1 | code | Language of the resource contentrequired: all-languages |
text | 0..1 | Text summary of the resource, for human interpretation | |
contained | 0..* | Resource | Contained, inline Resources |
extension | 0..* | Additional content defined by implementations | |
modifierExtension | 0..* | Extensions that cannot be ignored | |
url | 0..1 | uri | Canonical identifier for this operation definition, represented as an absolute URI (globally unique) |
identifier | 0..* | Additional identifier for the implementation guide (business identifier) | |
version | 0..1 | string | Business version of the operation definition |
versionAlgorithm[x] | 0..1 | stringCoding | How to compare versionsextensible: version-algorithm |
name | 1..1 | string | Name for this operation definition (computer friendly) |
title | 0..1 | string | Name for this operation definition (human friendly) |
status | 1..1 | code | draft | active | retired | unknownrequired: publication-status |
kind | 1..1 | code | operation | queryrequired: operation-kind |
experimental | 0..1 | boolean | For testing purposes, not real usage |
date | 0..1 | dateTime | Date last changed |
publisher | 0..1 | string | Name of the publisher/steward (organization or individual) |
contact | 0..* | Contact details for the publisher | |
description | 0..1 | markdown | Natural language description of the operation definition |
useContext | 0..* | The context that the content is intended to support | |
jurisdiction | 0..* | Intended jurisdiction for operation definition (if applicable)extensible: jurisdiction | |
purpose | 0..1 | markdown | Why this operation definition is defined |
copyright | 0..1 | markdown | Use and/or publishing restrictions |
copyrightLabel | 0..1 | string | Copyright holder and year(s) |
affectsState | 0..1 | boolean | Whether content is changed by the operation |
code | 1..1 | code | Recommended name for operation in search url |
comment | 0..1 | markdown | Additional information about use |
base | 0..1 | canonical | Marks this as a profile of the base |
resource | 0..* | code | Types this operation applies torequired: version-independent-all-resource-types |
system | 1..1 | boolean | Invoke at the system level? |
type | 1..1 | boolean | Invoke at the type level? |
instance | 1..1 | boolean | Invoke on an instance? |
inputProfile | 0..1 | canonical | Validation information for in parameters |
outputProfile | 0..1 | canonical | Validation information for out parameters |
parameter | 0..* | BackboneElement | Parameters for the operation/query |
overload | 0..* | BackboneElement | Define overloaded variants for when generating code |