OperationDefinition

• Overview
• Retrieve by id
  • Authorization Types
  • Headers
  • Example
• List of OperationDefinitions

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. Operations that are defined as part of another implementation guide are referenced directly instead of being duplicated within this server. While the HL7^® FHIR^® specification also supports describing named queries with this resource, we do not currently support any custom named queries.

The following fields are returned if valued:

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

Retrieve by id

List an individual OperationDefinition by its id:

GET /OperationDefinition/:id

Implementation Notes

• Authentication is not required to access the OperationDefinition resource

• This resource can be retrieved by its defining URL or from the OperationDefinition resource located at the service root URL. For example, both of these URLs work:

  https://fhir-ehr.cerner.com/r4/OperationDefinition/binary-autogen-ccd-if

  https://fhir-open.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/OperationDefinition/binary-autogen-ccd-if

Authorization Types

Authorization is not required.

Headers

Accept: application/fhir+json

Example

Request

GET https://fhir-ehr.cerner.com/r4/OperationDefinition/binary-autogen-ccd-if

Response

Status: 200 OK

{
  "resourceType": "OperationDefinition",
  "id": "binary-autogen-ccd-if",
  "url": "https://fhir-ehr.cerner.com/r4/OperationDefinition/binary-autogen-ccd-if",
  "name": "GenerateContinuityOfCareDocument",
  "title": "Generate Continuity of Care Document (CCD)",
  "status": "active",
  "kind": "operation",
  "date": "2019-01-18",
  "publisher": "Cerner",
  "description": "Generates a copy of a patient's Continuity of Care Document (CCD) as a Binary",
  "code": "autogen-ccd-if",
  "resource": [
    "Binary"
  ],
  "system": false,
  "type": true,
  "instance": false,
  "parameter": [
    {
      "name": "patient",
      "use": "in",
      "min": 1,
      "max": "1",
      "documentation": "The id of the patient that is the subject of the generated Continuity of Care Document (CCD).",
      "type": "id"
    },
    {
      "name": "start",
      "use": "in",
      "min": 0,
      "max": "1",
      "documentation": "The start of the date range for which the Continuity of Care Document (CCD) is to be generated. If no start date is provided, then the document will be generated with all records up to the end or current date.",
      "type": "date"
    },
    {
      "name": "end",
      "use": "in",
      "min": 0,
      "max": "1",
      "documentation": "The end of the date range for which the Continuity of Care Document (CCD) is to be generated. If no end date is provided, then the document will be generated with all records up to the current date.",
      "type": "date"
    },
    {
      "name": "result",
      "use": "out",
      "min": 1,
      "max": "1",
      "documentation": "Binary for the generated Continuity of Care Document (CCD)",
      "type": "Binary"
    }
  ]
}

List of OperationDefinitions

ID	Description
binary-autogen-ccd-if	Generates a copy of a patient’s Continuity of Care Document (CCD) as a Binary.
organization-get-cg-for-mrcu	Retrieves details for a caregiver organization given a care unit organization id.
group-export	Obtains a detailed set of FHIR resources of diverse resource types pertaining to all patients in specified Group.
charge_item_modify	Modifies an existing ChargeItem resulting in a newly created ChargeItem.
charge_item_create	Creates a charge event which can result in the creation of one or more ChargeItems.
charge_item_credit	Creates an offsetting ChargeItem for an existing debit ChargeItem.