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

An absolute URL that is used to identify this operation definition when it is referenced in a specification, model, design or an instance. This SHALL be a URL, SHOULD be globally unique, and SHOULD be an address at which this operation definition is (or will be) published.

Can be a urn:uuid: or a urn:oid:.

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.

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.

A free text natural language name identifying the operation.

Not expected to be globally unique.

The status of the profile.

Allows filtering of profiles that are appropriate for use vs. not.

Whether this is an operation or a named query.

Named queries are invoked differently, and have different capabilities.

This profile was authored for testing purposes (or education/evaluation/marketing), and is not intended to be used for genuine usage.

Allows filtering of profiles that are appropriate for use vs. not.

The name of the individual or organization that published the operation definition.

Helps establish the "authority/credibility" of the operation definition. May also allow for contact.

Usually an organization, but may be an individual. This item SHOULD be populated unless the information is available from context.

Contacts to assist a user in finding and communicating with the publisher.

May be a web site, an email address, a telephone number (tel:), etc.

The name of an individual to contact regarding the operation definition.

If there is no named individual, the telecom is for the organization as a whole.

Contact details for individual (if a name was provided) or the publisher.

The date this version of the operation definition was published. The date must change when the business version changes, if it does, and it must change if the status code changes. In addition, it should change when the substantive content of the Operation Definition changes.

Additional specific dates may be added as extensions.

A free text natural language description of the profile and its use.

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.

Explains why this operation definition is needed and why it's been constrained as it has.

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.

Operations that are idempotent (see HTTP specification definition of idempotent ) may be invoked by performing an HTTP GET operation instead of a POST.

The name used to invoke the operation.

Additional information about how to use this operation or named query.

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.

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).

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).

Indicates whether this operation can be invoked on a particular instance of one of the given types.

The parameters for the operation/query.

Query Definitions only have one output parameter, named "result". This may not be described, but can be to allow a profile to be defined.

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.

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.

The minimum number of times this parameter SHALL appear in the request or response.

The maximum number of times this element is permitted to appear in the request or response.

Describes the meaning or use of this parameter.

The type for this parameter.

if there is no stated parameter, then the parameter is a "Tuple" type and must have at least one part defined.

A profile the specifies the rules that this parameter must conform to.

Binds to a value set if this parameter is coded (code, Coding, CodeableConcept).

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.

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.

The parts of a Tuple Parameter.

Query Definitions only have one output parameter, named "result". This may not be described, but can be to allow a profile to be defined.