Jump to

• Request
• Response

Get an operation definition by ID

get

/OperationDefinition/{ID}

Retrieves an individual operation definition by the operation definition ID.

Note: You can retrieve this resource by its defining URL or from the OperationDefinition resource located at the service root URL.

For example, both of the following 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.

Request

Path Parameters

• ID(required): string
  The logical resource ID associated with the resource.

Header Parameters

• accept(required): string
  The media type to be requested. See what the resource's operation produces for what is supported.

Back to Top

Response

Supported Media Types

• application/json+fhir

Default Response

Example Request:

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

Example Response:

{
  "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"
    }
  ]
}

Headers

• X-Request-Id: string
  Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, provide the X-Request-Id, if present.
• opc-request-id: string
  Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, provide the opc-Request-Id, if present.

Back to Top