OperationDefinition REST Endpoints

Sort by

Task Path Method

Description

OperationDefinition

This topic describes information for the OperationDefinition resource.

Overview

The OperationDefinition resource defines an operation. This includes the inputs, outputs, description, and other items necessary to actually execute the operation.

This resource only exposes the custom operations our server defines (group-export and patient-export). While the Health Level Seven (HL7) Fast Healthcare Interoperability Resources (FHIR) specification also supports describing named queries with this resource, Oracle Cerner currently does not support any custom-named queries.

Note:

The examples provided here are non-normative and replaying them in the public sandbox is not guaranteed to yield the results shown on the site.

Error: The common errors and OperationOutcomes may be returned.

The search results include the following fields if they contain values:

• ID
• Name
• Title
• Status
• URL
• Kind
• Date
• Publisher
• Description
• Jurisdiction
• Code
• Resource
• System
• Type
• Instance
• Parameter

List of OperationDefinition IDs

Table - List of Operation Definitions

ID	Description
patient-export	FHIR operation to obtain a detailed set of FHIR resources of diverse resource types pertaining to all patients.
group-export	FHIR operation to obtain a detailed set of FHIR resources of diverse resource types that pertain to all patients in a specified group. patients in specified Group.

OperationDefinition

The operations from the OperationDefinition category.

Get a list of operations

Method: get

Path: /OperationDefinition

Get an operation by ID

Method: get

Path: /OperationDefinition/{ID}