OperationDefinition - FHIR Resource (dstu2)
This OperationDefinition Resource uses the FHIR API standard for access and structure.
Validate an OperationDefinition FHIR Resource (dstu2)
OperationDefinition Attributes
AttributeField is listTypeDescription
Description: draft | active | retired
FHIR Version: dstu2
Attribute Type : code
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"status": Learn more about the (OperationDefinition) status FHIR attribute
Description: Name of the publisher (Organization or individual)
FHIR Version: dstu2
Attribute Type : string
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"publisher": Learn more about the (OperationDefinition) publisher FHIR attribute
Description: operation | query
FHIR Version: dstu2
Attribute Type : code
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"kind": Learn more about the (OperationDefinition) kind FHIR attribute
Description: Name used to invoke the operation
FHIR Version: dstu2
Attribute Type : code
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"code": Learn more about the (OperationDefinition) code FHIR attribute
Description: Why is this needed?
FHIR Version: dstu2
Attribute Type : string
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"requirements": Learn more about the (OperationDefinition) requirements FHIR attribute
Description: Informal name for this operation
FHIR Version: dstu2
Attribute Type : string
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"name": Learn more about the (OperationDefinition) name FHIR attribute
Description: Logical URL to reference this operation definition
FHIR Version: dstu2
Attribute Type : uri
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"url": Learn more about the (OperationDefinition) url FHIR attribute
Description: Invoke at resource level for these type
FHIR Version: dstu2
Attribute Type : code
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"type": Learn more about the (OperationDefinition) type FHIR attribute
Description: Additional information about use
FHIR Version: dstu2
Attribute Type : string
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"notes": Learn more about the (OperationDefinition) notes FHIR attribute
Description: Whether content is unchanged by operation
FHIR Version: dstu2
Attribute Type : boolean
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"idempotent": Learn more about the (OperationDefinition) idempotent FHIR attribute
Description: Invoke at the system level?
FHIR Version: dstu2
Attribute Type : boolean
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"system": Learn more about the (OperationDefinition) system FHIR attribute
Description: Invoke on an instance?
FHIR Version: dstu2
Attribute Type : boolean
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"instance": Learn more about the (OperationDefinition) instance FHIR attribute
Description: Contact details of the publisher
FHIR Version: dstu2
Attribute Type : Data Type
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"contact": Learn more about the (OperationDefinition) contact FHIR attribute
Description: Logical id for this version of the operation definition
FHIR Version: dstu2
Attribute Type : string
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"version": Learn more about the (OperationDefinition) version FHIR attribute
Description: Date for this version of the operation definition
FHIR Version: dstu2
Attribute Type : dateTime
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"date": Learn more about the (OperationDefinition) date FHIR attribute
Description: Marks this as a profile of the base
FHIR Version: dstu2
Attribute Type : Reference
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"base": Learn more about the (OperationDefinition) base FHIR attribute
Description: Parameters for the operation/query
FHIR Version: dstu2
Attribute Type : Data Type
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"parameter": Learn more about the (OperationDefinition) parameter FHIR attribute
Description: If for testing purposes, not real usage
FHIR Version: dstu2
Attribute Type : boolean
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"experimental": Learn more about the (OperationDefinition) experimental FHIR attribute
Description: Natural language description of the operation
FHIR Version: dstu2
Attribute Type : string
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"description": Learn more about the (OperationDefinition) description FHIR attribute
OperationDefinition Structure
{
"resourceType" : "OperationDefinition",
// from Resource: id, meta, implicitRules, and language
// from DomainResource: text, contained, extension, and modifierExtension
"url" : "<uri>", // Logical URL to reference this operation definition
"version" : "<string>", // Logical id for this version of the operation definition
"name" : "<string>", // R! Informal name for this operation
"status" : "<code>", // R! draft | active | retired
"kind" : "<code>", // R! operation | query
"experimental" : <boolean>, // If for testing purposes, not real usage
"publisher" : "<string>", // Name of the publisher (Organization or individual)
"contact" : [{ // Contact details of the publisher
"name" : "<string>", // Name of a individual to contact
"telecom" : [{ ContactPoint }] // Contact details for individual or publisher
}],
"date" : "<dateTime>", // Date for this version of the operation definition
"description" : "<string>", // Natural language description of the operation
"requirements" : "<string>", // Why is this needed?
"idempotent" : <boolean>, // Whether content is unchanged by operation
"code" : "<code>", // R! Name used to invoke the operation
"notes" : "<string>", // Additional information about use
"base" : { Reference(OperationDefinition) }, // Marks this as a profile of the base
"system" : <boolean>, // R! Invoke at the system level?
"type" : ["<code>"], // Invoke at resource level for these type
"instance" : <boolean>, // R! Invoke on an instance?
"parameter" : [{ // Parameters for the operation/query
"name" : "<code>", // R! Name in Parameters.parameter.name or in URL
"use" : "<code>", // R! in | out
"min" : <integer>, // R! Minimum Cardinality
"max" : "<string>", // R! Maximum Cardinality (a number or *)
"documentation" : "<string>", // Description of meaning/use
"type" : "<code>", // C? What type this parameter has
"profile" : { Reference(StructureDefinition) }, // Profile on the type
"binding" : { // ValueSet details if this is coded
"strength" : "<code>", // R! required | extensible | preferred | example
// valueSet[x]: Source of value set. One of these 2:
"valueSetUri" : "<uri>"
"valueSetReference" : { Reference(ValueSet) }
},
"part" : [{ Content as for OperationDefinition.parameter }] // C? Parts of a Tuple Parameter
}]
}
OperationDefinition Search Parameters
The following search parameters can be used to query OperationDefinition resources. Just submit them like so:
https://api.1up.health/fhir/dstu2/OperationDefinition?query-param=queryvalue| Search Parameter | Field Type | Resource Fields Searched |
|---|---|---|
base | reference | base |
code | text | code |
date | date | date |
instance | text | instance |
kind | text | kind |
name | text | name |
profile | reference | parameter.profile |
publisher | text | publisher |
status | text | status |
system | text | system |
type | text | type |
url | uri | url |
version | text | version |
