Skip to main content

OperationDefinitionParameter

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

type OperationDefinitionParameter implements Element {
  name: String
  use: String
  min: Int
  max: String
  documentation: String
  type: String
  targetProfile: [Uri]
  searchType: String
  binding: OperationDefinitionBinding
  referencedFrom: [OperationDefinitionReferencedFrom]
  part: [OperationDefinitionParameter]
  modifierExtension: [Extension]
  extension: [Extension]
  id: String
}

Fields​

OperationDefinitionParameter.name ● String scalar​

The name of used to identify the parameter.

OperationDefinitionParameter.use ● String scalar​

Whether this is an input or an output parameter.

OperationDefinitionParameter.min ● Int scalar​

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

OperationDefinitionParameter.max ● String scalar​

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

OperationDefinitionParameter.documentation ● String scalar​

Describes the meaning or use of this parameter.

OperationDefinitionParameter.type ● String scalar​

The type for this parameter.

OperationDefinitionParameter.targetProfile ● [Uri] list scalar​

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.

OperationDefinitionParameter.searchType ● String scalar​

How the parameter is understood as a search parameter. This is only used if the parameter type is string .

OperationDefinitionParameter.binding ● OperationDefinitionBinding object​

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

OperationDefinitionParameter.referencedFrom ● [OperationDefinitionReferencedFrom] list object​

Identifies other resource parameters within the operation invocation that are expected to resolve to this resource.

OperationDefinitionParameter.part ● [OperationDefinitionParameter] list object​

The parts of a nested Parameter.

OperationDefinitionParameter.modifierExtension ● [Extension] list object​

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

OperationDefinitionParameter.extension ● [Extension] list object​

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.

OperationDefinitionParameter.id ● String scalar​

Interfaces​

Element interface​

Base definition for all elements in a resource. If the element is present, it must have a value for at least one of the defined elements, an @id referenced from the Narrative, or extensions

Member Of​

OperationDefinition object ● OperationDefinitionParameter object