OperationDefinition

• Overview
• Retrieve by id
  • Authorization Types
  • Headers
  • Example

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
• Informal name
• Formal name
• Status
• Kind
• Name of publisher
• Date published
• Description
• Whether or not the operation can be invoked without a Resource
• Which resource types this operation can be invoked on
• Whether or not the operation can be invoked on a specific instance of the resource above
• Parameters (both in and out) and cardinality details

List of OperationDefinitions

• binary-autogen-ccd-if: Generate Continuity of Care Document (CCD)

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/dstu2/OperationDefinition/binary-autogen-ccd-if

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

Authorization Types

Authorization is not required.

Headers

Accept: application/json+fhir

Example

Request

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

Response

Status: 200 OK

{
  "resourceType": "OperationDefinition",
  "id": "binary-autogen-ccd-if",
  "url": "https://fhir-ehr.cerner.com/dstu2/OperationDefinition/binary-autogen-ccd-if",
  "name": "Generate Continuity of Care Document (CCD)",
  "status": "active",
  "kind": "operation",
  "publisher": "Cerner",
  "date": "2017-01-17",
  "description": "Generates a copy of a patient's Continuity of Care Document (CCD) as a Binary",
  "code": "autogen-ccd-if",
  "system": false,
  "type": [
    "Binary"
  ],
  "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 upto 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 records upto 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"
    }
  ]
}