OperationDefinition
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, Cerner currently does not support any custom-named queries.
The following fields are returned if valued:
- Id
- Name
- Title
- Status
- URL
- Kind
- Date
- Publisher
- Description
- Jurisdiction
- Code
- Resource
- System
- Type
- Instance
- Parameter
Search
List an individual operation by its supplied parameter:
GET /OperationDefinition?:parameters
Implementation Notes
- Authentication is not required to access the OperationDefinition resource
Authorization Types
Authorization is not required.
Headers
Accept: application/fhir+json, "application/json", "application/json+fhir"
Example
Request
GET https://fhir-ehr-sc.cerner.com/r4/2f8f5ec1-b7b8-4be5-ae27-e308284dd9c1/OperationDefinition?url=https://fhir-ehr-sc.cerner.com/r4/OperationDefinition/group-export
Response
Status: 200 OK
{
"resourceType": "Bundle",
"id": "2654004e-c122-4519-8eaf-c099997905aa",
"type": "searchset",
"timestamp": "2022-02-01T04:42:58-05:00",
"entry": [
{
"fullUrl": "https://fhir-ehr-sc.cerner.com/r4/2f8f5ec1-b7b8-4be5-ae27-e308284dd9c1/OperationDefinition?url=https://fhir-ehr-sc.cerner.com/r4/OperationDefinition/group-export",
"search": {
"mode": "match"
},
"resource": {
"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-01T04:42:58-05:00",
"publisher": "Cerner Corporation",
"description": "FHIR Operation to obtain a detailed set of FHIR resources of diverse resource types\n\t\t\t\tpertaining to all patients in specified Group. The FHIR server SHALL support invocation of this\n\t\t\t\toperation using the FHIR 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\t\ta. 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\t\tand group- level data export requests. Resource data shall only be returned for resource instances\n\t\t\t\twhere the last updated date/time is greater than the date/time supplied in the request. Data\n\t\t\t\tassociated with a resource that was created after the request start date/time (transactionTime)\n\t\t\t\tshall 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\t\t_type parameter on the patient- and group-level data export requests. Only Soarian Clinicals R4\n\t\t\t\tresources found in the _type string that are authorized for the population application should be\n\t\t\t\treturned",
"type": "string"
}
]
}
}
],
"link": [
{
"relation": "self",
"url": "https://fhir-ehr-sc.devcerner.com/r4/9015d117-44ed-4061-bec7-dabd439dc474/OperationDefinition?url=https://fhir-ehr-sc.devcerner.com/r4/OperationDefinition/group-export"
}
]
}
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-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
Authorization Types
Authorization is not required.
Headers
Accept: application/json+fhir, "application/json", "application/fhir+json"
Example
Request
GET https://fhir-ehr-sc.cerner.com/r4/2f8f5ec1-b7b8-4be5-ae27-e308284dd9c1/OperationDefinition/group-export
Response
Status: 200 OK
{
"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"
}
]
}
List of OperationDefinitions
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. |