This page is part of the FHIR Specification (v0.0.82: DSTU 1). The current version which supercedes this version is 5.0.0 . For a full list of available versions, see the Directory of published versions . Page versions: R5 R4B R4 R3 R2 Content Examples Detailed Descriptions Mappings Profiles 6.18.5 Resource OperationDefinition - Detailed Descriptions Detailed Descriptions for the elements in the OperationDefinition resource. OperationDefinition Definition A formal computable definition of an operation (on the RESTful interface) or a named query (using the search interaction). Control 1..1 OperationDefinition.url Definition An absolute url that is used to identify this operation definition when it is referenced in a specification, model, design or an instance (should be globally unique uri). Control 0..1 Type uri Comments Can be a urn:uuid: or a urn:oid:. OperationDefinition.version Definition The identifier that is used to identify this version of the profile when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the profile author manually and the value should be a timestamp. Note This is a business versionId, not a resource identifier (see discussion ) Control 0..1 Type string Requirements There may be multiple resource versions of the profile that have this same identifier. The resource version id will change for technical reasons, whereas the stated version number needs to be under the author's control. OperationDefinition.name Definition A free text natural language name identifying the Profile. Control 1..1 Type string Comments Not expected to be globally unique. OperationDefinition.publisher Definition The name of the individual or organization that published the operation definition. Control 0..1 Type string Requirements Helps establish the "authority/credibility" of the operation definition. May also allow for contact. Summary true Comments Usually an organization, but may be an individual. This item SHOULD be populated unless the information is available from context. OperationDefinition.contact Definition Contacts to assist a user in finding and communicating with the publisher. Control 0..* Summary true Comments May be a web site, an email address, a telephone number (tel:), etc. OperationDefinition.contact.name Definition The name of an individual to contact regarding the operation definition. Control 0..1 Type string Summary true Comments If there is no named individual, the telecom is for the organization as a whole. OperationDefinition.contact.telecom Definition Contact details for individual (if a name was provided) or the publisher. Control 0..* Type ContactPoint Summary true OperationDefinition.description Definition A free text natural language description of the profile and its use. Control 0..1 Type string Comments This field can be used for things such as why the profile was written, comments about misuse, instructions for clinical use and interpretation, literature references, examples from the paper world, etc. It is not a rendering of the profile as conveyed in Profile.text. This item SHOULD be populated unless the information is available from context. OperationDefinition.requirements Definition Explains why this operation definition is needed and why it's been constrained as it has. Control 0..1 Type string Comments This element does not describe the usage of the operation definition (that's done in comments), rather it's for traceability of why the element is either needed or why the constraints exist as they do. This may be used to point to source materials or specifications that drove the structure of this data element. OperationDefinition.status Definition The status of the profile. Control 1..1 Binding ConformanceResourceStatus: Required : http://hl7.org/fhir/conformance-resource-status (The lifecycle status of a Value Set or Concept Map) Type code Is Modifier true Requirements Allows filtering of profiles that are appropriate for use vs. not. OperationDefinition.experimental Definition This profile was authored for testing purposes (or education/evaluation/marketing), and is not intended to be used for genuine usage. Control 0..1 Type boolean Requirements Allows filtering of profiles that are appropriate for use vs. not. OperationDefinition.date Definition The date that this version of the profile was published. Control 0..1 Type dateTime OperationDefinition.kind Definition Whether this is operation or named query. Control 1..1 Binding OperationKind: Required : http://hl7.org/fhir/operation-kind (Whether an operation is a normal operation or a query) Type code Comments Named queries are invoked differently, and have different capabilities. OperationDefinition.code Definition The name used to invoke the operation. Control 1..1 Type code OperationDefinition.notes Definition Additional information about how to use this operation or named query. Control 0..1 Type string OperationDefinition.base Definition Indicates that this operation definition is a constraining profile on the base. Control 0..1 Type Reference ( OperationDefinition ) Comments A constrained profile can make optional parameters required or not used and clarify documentation. OperationDefinition.system Definition Indicates whether this operation or named query can be invoked at the system level (e.g. without needing to choose a resource type for the context). Control 1..1 Type boolean OperationDefinition.type Definition Indicates whether this operation or named query can be invoked at the resource type level for any given resource type level (e.g. without needing to choose a resource type for the context). Control 0..* Binding ResourceType: Any defined Resource Type name Type code OperationDefinition.instance Definition Indicates whether this operation can be invoked on a particular instance of one of the given types. Control 1..1 Type boolean OperationDefinition.parameter Definition The parameters for the operation/query. Control 0..* Comments Query Definitions only have one output parameter, named "result". This may not be described, but can be to allow a profile to be defined. Invariants Defined on this element opd-1 : Either a type must be provided, or parts (xpath: exists(f:type) or exists(f:part)) OperationDefinition.parameter.name Definition The name of used to identify the parameter. Control 1..1 Type code Comments This name must be a token (start with a letter in a..z, and only contain letters, numerals, and underscore. OperationDefinition.parameter.use Definition Whether this is an input or an output parameter. Control 1..1 Binding OperationParameterUse: Required : http://hl7.org/fhir/operation-parameter-use (Whether an operation parameter is an input or an output parameter) Type code Comments If a parameter name is used for both an input and an output parameter, the parameter should be defined twice. OperationDefinition.parameter.min Definition The minimum number of times this parameter SHALL appear in the request or response. Control 1..1 Type integer OperationDefinition.parameter.max Definition The maximum number of times this element is permitted to appear in the request or response. Control 1..1 Type string OperationDefinition.parameter.documentation Definition Describes the meaning or use of this parameter. Control 0..1 Type string OperationDefinition.parameter.type Definition The type for this parameter. Control 0..1 Binding OperationParameterType: Required : See http://hl7.org/fhir/vs/operation-definition-parameter-type (The type of a parameter) Type code Comments if there is no stated parameter, then the parameter is a "Tuple" type and must have at least one part defined. Invariants Affect this element opd-1 : Either a type must be provided, or parts (xpath: exists(f:type) or exists(f:part)) OperationDefinition.parameter.profile Definition A profile the specifies the rules that this parameter must conform to. Control 0..1 Type Reference ( StructureDefinition ) OperationDefinition.parameter.part Definition The parts of a Tuple Parameter. Control 0..* Comments Query Definitions only have one output parameter, named "result". This may not be described, but can be to allow a profile to be defined. Invariants Affect this element opd-1 : Either a type must be provided, or parts (xpath: exists(f:type) or exists(f:part)) OperationDefinition.parameter.part.name Definition The name of used to identify the parameter. Control 1..1 Type code Comments This name must be a token (start with a letter in a..z, and only contain letters, numerals, and underscore. OperationDefinition.parameter.part.min Definition The minimum number of times this parameter SHALL appear in the request or response. Control 1..1 Type integer OperationDefinition.parameter.part.max Definition The maximum number of times this element is permitted to appear in the request or response. Control 1..1 Type string OperationDefinition.parameter.part.documentation Definition Describes the meaning or use of this parameter. Control 0..1 Type string OperationDefinition.parameter.part.type Definition The type for this parameter. Control 1..1 Binding OperationParameterType: Required : See http://hl7.org/fhir/vs/operation-definition-parameter-type (The type of a parameter) Type code OperationDefinition.parameter.part.profile Definition A profile the specifies the rules that this parameter must conform to. Control 0..1 Type Reference ( StructureDefinition ) © HL7.org 2011+. FHIR DSTU (v0.4.0-4902) generated on Fri, Mar 27, 2015 00:21+1100. Links: What's a DSTU? | Version History | Specification Map | Compare to DSTU1 | | Propose a change