http://hl7.org/fhir/StructureDefinition/OperationDefinition|5.0.0
A formal computable definition of an operation (on the RESTful interface) or a named query (using the search interaction).
| Name | Flags | Card | Type | Description & Constraints |
|---|---|---|---|---|
OperationDefinition | 0..* | Definition of an operation or a named query | ||
Σ | 0..1 | uri | Canonical identifier for this operation definition, represented as an absolute URI (globally unique) | |
Σ | 0..* | Identifier | Additional identifier for the implementation guide (business identifier) | |
Σ | 0..1 | string | Business version of the operation definition | |
Σ | 0..1 | How to compare versions http://hl7.org/fhir/ValueSet/version-algorithm (extensible) | ||
Σ | 0..1 | string | http://hl7.org/fhir/ValueSet/version-algorithm (extensible) | |
Σ | 0..1 | Coding | http://hl7.org/fhir/ValueSet/version-algorithm (extensible) | |
Σ | 1..1 | string | Name for this operation definition (computer friendly) | |
Σ | 0..1 | string | Name for this operation definition (human friendly) | |
?!Σ | 1..1 | code | draft | active | retired | unknown PublicationStatus (required) | |
Σ | 1..1 | code | operation | query OperationKind (required) | |
Σ | 0..1 | boolean | For testing purposes, not real usage | |
Σ | 0..1 | dateTime | Date last changed | |
Σ | 0..1 | string | Name of the publisher/steward (organization or individual) | |
Σ | 0..* | ContactDetail | Contact details for the publisher | |
| 0..1 | markdown | Natural language description of the operation definition | ||
Σ | 0..* | UsageContext | The context that the content is intended to support | |
Σ | 0..* | CodeableConcept | Intended jurisdiction for operation definition (if applicable) Jurisdiction (extensible) | |
| 0..1 | markdown | Why this operation definition is defined | ||
| 0..1 | markdown | Use and/or publishing restrictions | ||
| 0..1 | string | Copyright holder and year(s) | ||
Σ | 0..1 | boolean | Whether content is changed by the operation | |
Σ | 1..1 | code | Recommended name for operation in search url | |
| 0..1 | markdown | Additional information about use | ||
Σ | 0..1 | canonical | Marks this as a profile of the base | |
Σ | 0..* | code | Types this operation applies to FHIRTypes (required) | |
Σ | 1..1 | boolean | Invoke at the system level? | |
Σ | 1..1 | boolean | Invoke at the type level? | |
Σ | 1..1 | boolean | Invoke on an instance? | |
| 0..1 | canonical | Validation information for in parameters | ||
| 0..1 | canonical | Validation information for out parameters | ||
| 0..* | BackboneElement | Parameters for the operation/query | ||
| 1..1 | code | Name in Parameters.parameter.name or in URL | ||
| 1..1 | code | in | out OperationParameterUse (required) | ||
| 0..* | code | instance | type | system OperationParameterScope (required) | ||
| 1..1 | integer | Minimum Cardinality | ||
| 1..1 | string | Maximum Cardinality (a number or *) | ||
| 0..1 | markdown | Description of meaning/use | ||
| 0..1 | code | What type this parameter has FHIRAllTypes (required) | ||
| 0..* | code | Allowed sub-type this parameter can have (if type is abstract) FHIRAllTypes (required) | ||
| 0..* | canonical | If type is Reference | canonical, allowed targets. If type is 'Resource', then this constrains the allowed resource types | ||
| 0..1 | code | number | date | string | token | reference | composite | quantity | uri | special SearchParamType (required) | ||
| 0..1 | BackboneElement | ValueSet details if this is coded | ||
| 1..1 | code | required | extensible | preferred | example BindingStrength (required) | ||
| 1..1 | canonical | Source of value set | ||
| 0..* | BackboneElement | References to this parameter | ||
| 1..1 | string | Referencing parameter | ||
| 0..1 | string | Element id of reference | ||
| 0..* | Parts of a nested Parameter | |||
| 0..* | BackboneElement | Define overloaded variants for when generating code | ||
| 0..* | string | Name of parameter to include in overload | ||
| 0..1 | string | Comments to go on overload |