OperationDefinition
activeFoundationA formal computable definition of an operation (on the RESTful interface) or a named query (using the search interaction).
| Path | Card. | Type | Description & Constraints |
|---|---|---|---|
| OperationDefinition | 0..* | — | Definition of an operation or a named query |
| .idΣ | 0..1 | String | Logical id of this artifact |
| .metaΣ | 0..1 | Meta | 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 content Bindinglanguages(preferred) |
| .text | 0..1 | Narrative | Text summary of the resource, for human interpretation |
| .contained | 0..* | Resource | Contained, inline Resources |
| .extension | 0..* | Extension | Additional content defined by implementations |
| .modifierExtension?! | 0..* | Extension | Extensions that cannot be ignored |
| .urlΣ | 0..1 | uri | Canonical identifier for this operation definition, represented as a URI (globally unique) |
| .versionΣ | 0..1 | string | Business version of the operation definition |
| .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 | unknown Bindingpublication-status(required) |
| .kindΣ | 1..1 | code | operation | query Bindingoperation-kind(required) |
| .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 (organization or individual) |
| .contactΣ | 0..* | ContactDetail | Contact details for the publisher |
| .description | 0..1 | markdown | Natural language description of the operation definition |
| .useContextΣ | 0..* | UsageContext | The context that the content is intended to support |
| .jurisdictionΣ | 0..* | CodeableConcept | Intended jurisdiction for operation definition (if applicable) Bindingjurisdiction(extensible) |
| .purpose | 0..1 | markdown | Why this operation definition is defined |
| .affectsStateΣ | 0..1 | boolean | Whether content is changed by the operation |
| .codeΣ | 1..1 | code | Name used to invoke the operation |
| .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 to Bindingresource-types(required) |
| .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 |
| .id | 0..1 | String | Unique id for inter-element referencing |
| .extension | 0..* | Extension | Additional content defined by implementations |
| .modifierExtension?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| .name | 1..1 | code | Name in Parameters.parameter.name or in URL |
| .use | 1..1 | code | in | out Bindingoperation-parameter-use(required) |
| .min | 1..1 | integer | Minimum Cardinality |
| .max | 1..1 | string | Maximum Cardinality (a number or *) |
| .documentation | 0..1 | string | Description of meaning/use |
| .type | 0..1 | code | What type this parameter has Bindingall-types(required) |
| .targetProfile | 0..* | canonical | If type is Reference | canonical, allowed targets |
| .searchType | 0..1 | code | number | date | string | token | reference | composite | quantity | uri | special Bindingsearch-param-type(required) |
| .binding | 0..1 | BackboneElement | ValueSet details if this is coded |
| .id | 0..1 | String | Unique id for inter-element referencing |
| .extension | 0..* | Extension | Additional content defined by implementations |
| .modifierExtension?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| .strength | 1..1 | code | required | extensible | preferred | example Bindingbinding-strength(required) |
| .valueSet | 1..1 | canonical | Source of value set |
| .referencedFrom | 0..* | BackboneElement | References to this parameter |
| .id | 0..1 | String | Unique id for inter-element referencing |
| .extension | 0..* | Extension | Additional content defined by implementations |
| .modifierExtension?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| .source | 1..1 | string | Referencing parameter |
| .sourceId | 0..1 | string | Element id of reference |
| .part | 0..* | — | Parts of a nested Parameter |
| .overload | 0..* | BackboneElement | Define overloaded variants for when generating code |
| .id | 0..1 | String | Unique id for inter-element referencing |
| .extension | 0..* | Extension | Additional content defined by implementations |
| .modifierExtension?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| .parameterName | 0..* | string | Name of parameter to include in overload |
| .comment | 0..1 | string | Comments to go on overload |