OperationDefinition

ResourceFoundation · ConformanceNormativeMaturity 5

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

StructureSearch parametersHL7 specificationStructureDefinition JSON

Tested supportFull test results →

Backends

PostgreSQLElasticsearch

Interactions

CreateReadUpdatePatchDelete

Search

20 of 22 parameters tested

Structure

Show inherited elements (20)

Element	Card.	Type	Description
urlΣ	0..1	uri	Canonical identifier for this operation definition, represented as a URI (globally unique)
versionΣ	0..1	string	Business version of the operation definition
nameRequiredΣ	1..1	string	Name for this operation definition (computer friendly)
titleΣ	0..1	string	Name for this operation definition (human friendly)
statusRequired?!Σ	1..1	code	draft | active | retired | unknownBinding (required): publication-status
kindRequiredΣ	1..1	code	operation | queryBinding (required): operation-kind
experimentalΣ	0..1	boolean	For testing purposes, not real usage
dateΣ	0..1	dateTime	Date last changed
publisherΣ	0..1	string	Name of the publisher (organization or individual)
contactΣ	0..*	ContactDetail	Contact details for the publisher
description	0..1	markdown	Natural language description of the operation definition
useContextΣ	0..*	UsageContext	The context that the content is intended to support
jurisdictionΣ	0..*	CodeableConcept	Intended jurisdiction for operation definition (if applicable)Binding (extensible): jurisdiction
purpose	0..1	markdown	Why this operation definition is defined
affectsStateΣ	0..1	boolean	Whether content is changed by the operation
codeRequiredΣ	1..1	code	Name used to invoke the operation
comment	0..1	markdown	Additional information about use
baseΣ	0..1	canonical(OperationDefinition)	Marks this as a profile of the base
resourceΣ	0..*	code	Types this operation applies toBinding (required): resource-types
systemRequiredΣ	1..1	boolean	Invoke at the system level?
typeRequiredΣ	1..1	boolean	Invoke at the type level?
instanceRequiredΣ	1..1	boolean	Invoke on an instance?
inputProfile	0..1	canonical(StructureDefinition)	Validation information for in parameters
outputProfile	0..1	canonical(StructureDefinition)	Validation information for out parameters
parameter	0..*	BackboneElement	Parameters for the operation/query
nameRequired	1..1	code	Name in Parameters.parameter.name or in URL
useRequired	1..1	code	in | outBinding (required): operation-parameter-use
minRequired	1..1	integer	Minimum Cardinality
maxRequired	1..1	string	Maximum Cardinality (a number or *)
documentation	0..1	string	Description of meaning/use
type	0..1	code	What type this parameter hasBinding (required): all-types
targetProfile	0..*	canonical(StructureDefinition)	If type is Reference | canonical, allowed targets
searchType	0..1	code	number | date | string | token | reference | composite | quantity | uri | specialBinding (required): search-param-type
binding	0..1	BackboneElement	ValueSet details if this is coded
strengthRequired	1..1	code	required | extensible | preferred | exampleBinding (required): binding-strength
valueSetRequired	1..1	canonical(ValueSet)	Source of value set
referencedFrom	0..*	BackboneElement	References to this parameter
sourceRequired	1..1	string	Referencing parameter
sourceId	0..1	string	Element id of reference
part	0..*	Same as OperationDefinition.parameter	Parts of a nested Parameter
overload	0..*	BackboneElement	Define overloaded variants for when generating code
parameterName	0..*	string	Name of parameter to include in overload
comment	0..1	string	Comments to go on overload

Σ in _summary results · ?! modifier element · 1.. required · inherited elements in grey

Search parameters

Query with GET [base]/OperationDefinition?[parameter]=[value]. Type decides which modifiers and prefixes apply, see search features.

Parameter	Type	Description	PG	ES
base	reference	Marks this as a profile of the base OperationDefinition.base
code	token	Name used to invoke the operation OperationDefinition.code
context	token	A use context assigned to the operation definition (OperationDefinition.useContext.value.ofType(CodeableConcept))
context-quantity	quantity	A quantity- or range-valued use context assigned to the operation definition (OperationDefinition.useContext.value.ofType(Quantity)) | (OperationDefinition.useContext.value.ofType(Range))
context-type	token	A type of use context assigned to the operation definition OperationDefinition.useContext.code
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
date	date	The operation definition publication date OperationDefinition.date
description	string	The description of the operation definition OperationDefinition.description
input-profile	reference	Validation information for in parameters OperationDefinition.inputProfile
instance	token	Invoke on an instance? OperationDefinition.instance
jurisdiction	token	Intended jurisdiction for the operation definition OperationDefinition.jurisdiction
kind	token	operation | query OperationDefinition.kind
name	string	Computationally friendly name of the operation definition OperationDefinition.name
output-profile	reference	Validation information for out parameters OperationDefinition.outputProfile
publisher	string	Name of the publisher of the operation definition OperationDefinition.publisher
status	token	The current status of the operation definition OperationDefinition.status
system	token	Invoke at the system level? OperationDefinition.system
title	string	The human-friendly name of the operation definition OperationDefinition.title
type	token	Invoke at the type level? OperationDefinition.type
url	uri	The uri that identifies the operation definition OperationDefinition.url
version	token	The business version of the operation definition OperationDefinition.version

PG: PostgreSQL, ES: Elasticsearch. passes its TestScript checks, fails, not tested yet.

Common parameters on every resource (8)

_haste-health-author	reference	The author of the resource
_id	token	Logical id of this artifact
_lastUpdated	date	When the resource version last changed
_profile	uri	Profiles this resource claims to conform to
_security	token	Security Labels applied to this resource
_source	uri	Identifies where the resource comes from
_tag	token	Tags applied to this resource
_type	token	Derived from the R4B Definition