OperationDefinition

A formal computable definition of an operation (on the RESTful interface) or a named query (using the search interaction).

Properties

Name	Required	Type	Description
url		uri	Canonical identifier for this operation definition, represented as a URI (globally unique) Details An absolute URI that is used to identify this operation definition when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which at which an authoritative instance of this operation definition is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the operation definition is stored on different servers. Can be a urn:uuid: or a urn:oid: but real http: addresses are preferred. Multiple instances may share the same URL if they have a distinct version. The determination of when to create a new version of a resource (same url, new version) vs. defining a new artifact is up to the author. Considerations for making this decision are found in [Technical and Business Versions](resource.html#versions). In some cases, the resource can no longer be found at the stated url, but the url itself cannot change. Implementations can use the [meta.source](resource.html#meta) element to indicate where the current master source of the resource can be found.
version		string	Business version of the operation definition Details The identifier that is used to identify this version of the operation definition when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the operation definition author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence. There may be different operation definition instances that have the same identifier but different versions. The version can be appended to the url in a reference to allow a reference to a particular business version of the operation definition with the format [url]|[version].
name	✓	string	Name for this operation definition (computer friendly) Details A natural language name identifying the operation definition. This name should be usable as an identifier for the module by machine processing applications such as code generation. The name is not expected to be globally unique. The name should be a simple alphanumeric type name to ensure that it is machine-processing friendly.
title		string	Name for this operation definition (human friendly) Details A short, descriptive, user-friendly title for the operation definition. This name does not need to be machine-processing friendly and may contain punctuation, white-space, etc.
status	✓	code	draft | active | retired | unknown Details The status of this operation definition. Enables tracking the life-cycle of the content. Allows filtering of operation definitions that are appropriate for use versus not.
kind	✓	code	operation | query Details Whether this is an operation or a named query. Named queries are invoked differently, and have different capabilities.
experimental		boolean	For testing purposes, not real usage Details A Boolean value to indicate that this operation definition is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage. Allows filtering of operation definitions that are appropriate for use versus not.
date		dateTime	Date last changed Details The date (and optionally time) when the operation definition was published. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the operation definition changes. Note that this is not the same as the resource last-modified-date, since the resource may be a secondary representation of the operation definition. Additional specific dates may be added as extensions or be found by consulting Provenances associated with past versions of the resource.
publisher		string	Name of the publisher (organization or individual) Details The name of the organization or individual that published the operation definition. Usually an organization but may be an individual. The publisher (or steward) of the operation definition is the organization or individual primarily responsible for the maintenance and upkeep of the operation definition. This is not necessarily the same individual or organization that developed and initially authored the content. The publisher is the primary point of contact for questions or issues with the operation definition. This item SHOULD be populated unless the information is available from context.
contact		ContactDetail[]	Contact details for the publisher Details Contact details to assist a user in finding and communicating with the publisher. May be a web site, an email address, a telephone number, etc.
description		markdown	Natural language description of the operation definition Details A free text natural language description of the operation definition from a consumer's perspective. This description can be used to capture details such as why the operation definition was built, comments about misuse, instructions for clinical use and interpretation, literature references, examples from the paper world, etc. It is not a rendering of the operation definition as conveyed in the 'text' field of the resource itself. This item SHOULD be populated unless the information is available from context (e.g. the language of the operation definition is presumed to be the predominant language in the place the operation definition was created).
useContext		UsageContext[]	The context that the content is intended to support Details The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate operation definition instances. When multiple useContexts are specified, there is no expectation that all or any of the contexts apply.
jurisdiction		CodeableConcept[]	Intended jurisdiction for operation definition (if applicable) Details A legal or geographic region in which the operation definition is intended to be used. It may be possible for the operation definition to be used in jurisdictions other than those for which it was originally designed or intended.
purpose		markdown	Why this operation definition is defined Details Explanation of why this operation definition is needed and why it has been designed as it has. This element does not describe the usage of the operation definition. Instead, it provides traceability of ''why'' the resource is either needed or ''why'' it is defined as it is. This may be used to point to source materials or specifications that drove the structure of this operation definition.
affectsState		boolean	Whether content is changed by the operation Details Whether the operation affects state. Side effects such as producing audit trail entries do not count as 'affecting state'. What http methods can be used for the operation depends on the .affectsState value and whether the input parameters are primitive or complex: 1. Servers SHALL support POST method for all operations. 2. Servers SHALL support GET method if all the parameters for the operation are primitive or there are no parameters and the operation has affectsState = false.
code	✓	code	Name used to invoke the operation Details The name used to invoke the operation.
comment		markdown	Additional information about use Details Additional information about how to use this operation or named query.
base		canonical	Marks this as a profile of the base Details Indicates that this operation definition is a constraining profile on the base. A constrained profile can make optional parameters required or not used and clarify documentation.
resource		code[]	Types this operation applies to Details The types on which this operation can be executed. If the type is an abstract resource ("Resource" or "DomainResource") then the operation can be invoked on any concrete specialization.
system	✓	boolean	Invoke at the system level? Details 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).
type	✓	boolean	Invoke at the type level? Details 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 specific resource id for the context).
instance	✓	boolean	Invoke on an instance? Details Indicates whether this operation can be invoked on a particular instance of one of the given types.
inputProfile		canonical	Validation information for in parameters Details Additional validation information for the in parameters - a single profile that covers all the parameters. The profile is a constraint on the parameters resource as a whole. If present the profile shall not conflict with what is specified in the parameters in the operation definition (max/min etc.), though it may provide additional constraints. The constraints expressed in the profile apply whether the operation is invoked by a POST wih parameters or not.
outputProfile		canonical	Validation information for out parameters Details Additional validation information for the out parameters - a single profile that covers all the parameters. The profile is a constraint on the parameters resource. If present the profile shall not conflict with what is specified in the parameters in the operation definition (max/min etc.), though it may provide additional constraints. The constraints expressed in the profile apply whether the operation is invoked by a POST wih parameters or not.
parameter		OperationDefinitionParameter[]	Parameters for the operation/query Details The parameters for the operation/query. Query Definitions only have one output parameter, named "result". This might not be described, but can be to allow a profile to be defined.
id		string	Unique id for inter-element referencing Details Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
extension		Extension[]	Additional content defined by implementations Details May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
modifierExtension		Extension[]	Extensions that cannot be ignored even if unrecognized Details May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
name	✓	code	Name in Parameters.parameter.name or in URL Details The name of used to identify the parameter. This name must be a token (start with a letter in a..z, and only contain letters, numerals, and underscore. Note that for search parameters (type = string, with a search type), the name may be altered by the search modifiers.
use	✓	code	in | out Details Whether this is an input or an output parameter. If a parameter name is used for both an input and an output parameter, the parameter should be defined twice.
min	✓	integer	Minimum Cardinality Details The minimum number of times this parameter SHALL appear in the request or response.
max	✓	string	Maximum Cardinality (a number or *) Details The maximum number of times this element is permitted to appear in the request or response.
documentation		string	Description of meaning/use Details Describes the meaning or use of this parameter.
type		code	What type this parameter has Details The type for this parameter. if there is no stated parameter, then the parameter is a multi-part parameter; type and must have at least one part defined.
targetProfile		canonical[]	If type is Reference | canonical, allowed targets Details Used when the type is "Reference" or "canonical", and identifies a profile structure or implementation Guide that applies to the target of the reference this parameter refers to. If any profiles are specified, then the content must conform to at least one of them. The URL can be a local reference - to a contained StructureDefinition, or a reference to another StructureDefinition or Implementation Guide by a canonical URL. When an implementation guide is specified, the target resource SHALL conform to at least one profile defined in the implementation guide. Often, these profiles are the base definitions from the spec (e.g. http://hl7.org/fhir/StructureDefinition/Patient).
searchType		code	number | date | string | token | reference | composite | quantity | uri | special Details How the parameter is understood as a search parameter. This is only used if the parameter type is 'string'.
binding		OperationDefinitionParameterBinding	ValueSet details if this is coded Details Binds to a value set if this parameter is coded (code, Coding, CodeableConcept).
id		string	Unique id for inter-element referencing Details Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
extension		Extension[]	Additional content defined by implementations Details May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
modifierExtension		Extension[]	Extensions that cannot be ignored even if unrecognized Details May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
strength	✓	code	required | extensible | preferred | example Details Indicates the degree of conformance expectations associated with this binding - that is, the degree to which the provided value set must be adhered to in the instances. For further discussion, see [Using Terminologies](terminologies.html).
valueSet	✓	canonical	Source of value set Details Points to the value set or external definition (e.g. implicit value set) that identifies the set of codes to be used. For value sets with a referenceResource, the display can contain the value set description. The reference may be version-specific or not.
referencedFrom		OperationDefinitionParameterReferencedFrom[]	References to this parameter Details Identifies other resource parameters within the operation invocation that are expected to resolve to this resource. Resolution applies if the referenced parameter exists.
id		string	Unique id for inter-element referencing Details Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
extension		Extension[]	Additional content defined by implementations Details May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
modifierExtension		Extension[]	Extensions that cannot be ignored even if unrecognized Details May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
source	✓	string	Referencing parameter Details The name of the parameter or dot-separated path of parameter names pointing to the resource parameter that is expected to contain a reference to this resource.
sourceId		string	Element id of reference Details The id of the element in the referencing resource that is expected to resolve to this resource.
part		[]	Parts of a nested Parameter Details The parts of a nested Parameter. Query Definitions only have one output parameter, named "result". This might not be described, but can be to allow a profile to be defined.
overload		OperationDefinitionOverload[]	Define overloaded variants for when generating code Details Defines an appropriate combination of parameters to use when invoking this operation, to help code generators when generating overloaded parameter sets for this operation. The combinations are suggestions as to which sets of parameters to use together, but the combinations are not intended to be authoritative.
id		string	Unique id for inter-element referencing Details Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
extension		Extension[]	Additional content defined by implementations Details May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
modifierExtension		Extension[]	Extensions that cannot be ignored even if unrecognized Details May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
parameterName		string[]	Name of parameter to include in overload Details Name of parameter to include in overload.
comment		string	Comments to go on overload Details Comments to go on overload.

Search Parameters

Name	Type	Description	Expression
context	token	A use context assigned to the operation definition	OperationDefinition.useContext.value
context-quantity	quantity	A quantity- or range-valued use context assigned to the operation definition	OperationDefinition.useContext.value
context-type	token	A type of use context assigned to the operation definition	OperationDefinition.useContext.code
date	date	The operation definition publication date	OperationDefinition.date
description	string	The description of the operation definition	OperationDefinition.description
jurisdiction	token	Intended jurisdiction for the operation definition	OperationDefinition.jurisdiction
name	string	Computationally friendly name of the operation definition	OperationDefinition.name
publisher	string	Name of the publisher of the operation definition	OperationDefinition.publisher
status	token	The current status of the operation definition	OperationDefinition.status
title	string	The human-friendly name of the operation definition	OperationDefinition.title
url	uri	The uri that identifies the operation definition	OperationDefinition.url
version	token	The business version of the operation definition	OperationDefinition.version
context-type-quantity	composite	A use context type and quantity- or range-based value assigned to the operation definition	OperationDefinition.useContext
context-type-value	composite	A use context type and value assigned to the operation definition	OperationDefinition.useContext
base	reference	Marks this as a profile of the base	OperationDefinition.base
code	token	Name used to invoke the operation	OperationDefinition.code
input-profile	reference	Validation information for in parameters	OperationDefinition.inputProfile
instance	token	Invoke on an instance?	OperationDefinition.instance
kind	token	operation | query	OperationDefinition.kind
output-profile	reference	Validation information for out parameters	OperationDefinition.outputProfile
system	token	Invoke at the system level?	OperationDefinition.system
type	token	Invoke at the type level?	OperationDefinition.type

Inherited Properties

Name	Required	Type	Description
id		string	Logical id of this artifact Details The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. The only time that a resource does not have an id is when it is being submitted to the server using a create operation.
meta		Meta	Metadata about the resource Details The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
implicitRules		uri	A set of rules under which this content was created Details A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.
language		code	Language of the resource content Details The base language in which the resource is written. Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).
text		Narrative	Text summary of the resource, for human interpretation Details A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.
contained		Resource[]	Contained, inline Resources Details These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.
extension		Extension[]	Additional content defined by implementations Details May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
modifierExtension		Extension[]	Extensions that cannot be ignored Details May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.