Jump to

• Request
• Response

Get an operation by ID

get

/OperationDefinition/{ID}

List an individual OperationDefinition by its ID.

GET /OperationDefinition/:id

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 mentioed in R4 Overview. For example, both of these URLs work:

  https://fhir-ehr-sc.cerner.com/r4/2f8f5ec1-b7b8-4be5-ae27e308284dd9c1/OperationDefinition?url=https://fhir-ehr-sc.cerner.com/r4/OperationDefinition/group-export

  https://fhir-ehr-sc.cerner.com/r4/2f8f5ec1-b7b8-4be5-ae27-e308284dd9c1/OperationDefinition/group-export

Request

Path Parameters

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

Header Parameters

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

Back to Top

Response

Supported Media Types

• application/json+fhir
• application/json
• application/fhir+json

Default Response

Search by ID
Example Request

GET https://fhir-ehr-sc.cerner.com/r4/2f8f5ec1-b7b8-4be5-ae27-e308284dd9c1/OperationDefinition/group-export
 

Example Response

{
   "resourceType": "OperationDefinition",
   "id": "group-export",
   "name": "GrouplevelExport",
   "title": "Soarian Clinicals OperationDefinition for FHIR Bulk API - GrouplevelExport",
   "status": "active",
   "url": "https://fhir-ehr-sc.cerner.com/r4/OperationDefinition/group-export",
   "kind": "operation",
   "date": "2022-02-01T05:32:30-05:00",
   "publisher": "Cerner Corporation",
   "description": "FHIR Operation to obtain a detailed set of FHIR resources of diverse resource types pertaining\n\t  to all patients in specified Group. The FHIR server SHALL support invocation of this operation using the FHIR\n\t  Asynchronous Request Pattern.",
   "jurisdiction": [
     {
       "coding": [
         {
           "system": "http://unstats.un.org/unsd/methods/m49/m49.html",
           "code": "840",
           "display": "USA"
         }
       ]
     }
   ],
   "code": "export",
   "resource": "Group",
   "system": "false",
   "type": "false",
   "instance": "true",
   "parameter": [
     {
       "name": "_outputformat",
       "use": "in",
       "min": "1",
       "max": "1",
       "documentation": "The format for the requested bulk data files to be generated. Accepted values are:\n\t\t  a. application/fhir+ndjson, b. application/ndjson and c. ndjson\\",
       "type": "string"
     },
     {
       "name": "_since",
       "use": "in",
       "min": "1",
       "max": "1",
       "documentation": "The system shall support a date/time field in the _since parameter on the patient-\n\t\t  and group- level data export requests. Resource data shall only be returned for resource instances\n\t\t  where the last updated date/time is greater than the date/time supplied in the request. Data\n\t\t  associated with a resource that was created after the request start date/time (transactionTime)\n\t\t  shall not be returned.",
       "type": "instant"
     },
     {
       "name": "_type",
       "use": "in",
       "min": "1",
       "max": "1",
       "documentation": "The system shall support a string of comma-delimited FHIR resource types in the\n\t\t  _type parameter on the patient- and group-level data export requests. Only Soarian Clinicals R4\n\t\t  resources found in the _type string that are authorized for the population application should be\n\t\t  returned",
       "type": "string"
     }
   ]
 }
 

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