A formal computable definition of an operation (on the RESTful interface) or a named query (using the search interaction).
A formal computable definition of an operation (on the RESTful interface) or a named query (using the search interaction).
If the element is present, it must have either a @value, an @id, or extensions
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 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.
A formal identifier that is used to identify this implementation guide when it is represented in other formats, or referenced in a specification, model, design or an instance.
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.
Indicates the mechanism used to compare versions to determine which is more current.
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.
A short, descriptive, user-friendly title for the operation definition.
The current state of this operation definition.
Whether this is an operation or a named query.
A Boolean value to indicate that this operation definition is authored for testing purposes (or education/evaluation/marketing) and is not intended for genuine usage.
The date (and optionally time) when the operation definition was last significantly changed. 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.
The name of the organization or individual responsible for the release and ongoing maintenance of the operation definition.
Contact details to assist a user in finding and communicating with the publisher.
A free text natural language description of the operation definition from a consumer's perspective.
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.
A legal or geographic region in which the operation definition is intended to be used.
Explanation of why this operation definition is needed and why it has been designed as it has.
A copyright statement relating to the operation definition and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the operation definition.
A short string (<50 characters), suitable for inclusion in a page footer that identifies the copyright holder, effective period, and optionally whether rights are resctricted. (e.g. 'All rights reserved', 'Some rights reserved').
Whether the operation affects state. Side effects such as producing audit trail entries do not count as 'affecting state'.
The label that is recommended to be used in the URL for this operation. In some cases, servers may need to use a different CapabilityStatement operation.name to differentiate between multiple SearchParameters that happen to have the same code.
Additional information about how to use this operation or named query.
Indicates that this operation definition is a constraining profile on the base.
The types on which this operation can be executed.
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 specific resource id for the context).
Indicates whether this operation can be invoked on a particular instance of one of the given types.
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.
Additional validation information for the out parameters - a single profile that covers all the parameters. The profile is a constraint on the parameters resource.
The parameters for the operation/query.
Defines an appropriate combination of parameters to use when invoking this operation, to help code generators when generating overloaded parameter sets for this operation.
A formal computable definition of an operation (on the RESTful interface) or a named query (using the search interaction).
The name of used to identify the parameter.
Whether this is an input or an output parameter.
If present, indicates that the parameter applies when the operation is being invoked at the specified level.
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.
Support for polymorphic types. If the parameter type is abstract, this element lists allowed sub-types for the parameter.
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.
How the parameter is understood if/when it used as search parameter. This is only used if the parameter is a string.
Binds to a value set if this parameter is coded (code, Coding, CodeableConcept).
Identifies other resource parameters within the operation invocation that are expected to resolve to this resource.
The parts of a nested Parameter.
A formal computable definition of an operation (on the RESTful interface) or a named query (using the search interaction).
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.
Points to the value set or external definition (e.g. implicit value set) that identifies the set of codes to be used.
A formal computable definition of an operation (on the RESTful interface) or a named query (using the search interaction).
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.
The id of the element in the referencing resource that is expected to resolve to this resource.
A formal computable definition of an operation (on the RESTful interface) or a named query (using the search interaction).
Name of parameter to include in overload.
Comments to go on overload.
In
Out
If the element is present, it must have either a @value, an @id, or extensions
Instance
Type
System
If the element is present, it must have either a @value, an @id, or extensions
Operation
Query
If the element is present, it must have either a @value, an @id, or extensions