This OperationDefinition profile is part of the set of resource profiles supported by the API Server used with the athenaPractice 12.3 and athenaFlow 9.12 products. It further describes read. Note: The search, create and update operations are NOT supported for this resource.
This resource represents an operation supported by the API Server. It can be used to understand the parameters supported by the operations the API Server implements.
This profile is used to describe operations implemented by the API Server.
A list of the API Server's supported operations can be found in its Conformance resource
The operations supported by this resource are listed below.
Read operations are executed as specified in the HL7 FHIR read operation definition. To read a List, an application shall perform an HTTP GET, specifying the identifier of the resources being retrieved.
GET [base]/fhir/OperationDefinition/[id]{?_format=[json|xml]&_summary=[true|data]}
| Parameter | Description |
|---|---|
| [base] | Specifies the base URL of the FHIR Server, e.g., https://cpsapisandbox.virenceaz.com:9443/demoAPIServer |
| [id] | Specifies the identifier of the OperationDefinition resource to retrieve. |
| [_format] | Specifies the format of the output and may be xml or json. When present, the _format value overrides the value of the Accept header in the request. |
| [_summary] | Filters the output to include only summary elements (_summary=true) or to omit the generated narrative (_summary=data). Note: If the generated html narrative for the resource is not going to be used by the call, using _summary=data provides slightly improved API response times. |
| Response Code | Description |
|---|---|
| 200 OK | The requested resource was found and is contained within the body of the HTTP response. |
| 404 Not Found | The requested resource does not exist. The body of the HTTP response will contain an OperationOutcome resource that indicates that the resource could not be found. |
| 500 Server Error | The server may return other error codes to indicate other error conditions. The body of the HTTP response will contain an OperationOutcome resource that indicates the nature of the error. |
The official URL for this profile is:
http://hl7.org/fhir/StructureDefinition/operationdefinition-profile
The API Server supports the following fields of the OperationDefinition resource: