Send Requests

Use these guidelines when sending requests using the Oracle Health Clinical Data Exchange REST API.

URL Structure

Here's the URL structure for the requests:

  • Proprietary Oracle Health Clinical Data Exchange APIs. The request structure is as follows:

    https://cdexhub.<cloud_region>.oci.oraclecloud.com/20180828/<resource_path>
    Where:
    • <cloud_region> is Oracle Cloud Infrastructure region for your tenancy. For example, us-chicago-1.
    • <resource_path> is the relative path that defines the resource. For example:

      /workRequests/{workRequestId}
  • FHIR APIs. The request structure is as follows:

    https://cell1.query.cdexhub.<cloud_region>.oci.oraclecloud.com/fhir/r4/<query_endpoint_alias>/<resource_path>
    Where:
    • <cloud_region> is Oracle Cloud Infrastructure region for your tenancy. For example, us-chicago-1.
    • <query_endpoint_alias> is the string in the URL that the system generates to make requests against a specific query endpoint resource. For example, e48ebcb3-4027-5c58-ac57-e866afc7be0c.
    • <resource_path> is the relative path that defines the resource. For example:

      /DocumentReference

Supported Methods

You can perform basic CRUD operations (create, read, update, and delete) on a resource by using standard HTTP method requests, as summarized in the following table.

HTTP Method Description
GET Retrieve information about the Oracle Health Clinical Data Exchange resource.
POST Create the Oracle Health Clinical Data Exchange resource.
DELETE Delete the Oracle Health Clinical Data Exchange resource.
PUT Update the Oracle Health Clinical Data Exchange resource.

Media Types

The following media types are supported by the Oracle Health Clinical Data Exchange REST API:

  • application/json

Supported Headers

The Oracle Health Clinical Data Exchange REST API supports the following headers that may be passed in the header section of the HTTP request or response.

Header Description Example
Accept-Encoding List of acceptable encodings to support compression. Accept-Encoding: gzip
Content-Encoding List of acceptable encodings to support compression. Content-Encoding: deflate
Content-Type Media type of the body of the request. Required for POST and PUT requests. Content-Type: application/json
X-ID-TENANT-NAME Identity domain name of Oracle Health Clinical Data Exchange, used for authentication. X-ID-TENANT-NAME:ExampleIdentityDomain

Compression

Use compression on the Oracle Health Clinical Data Exchange REST resource request and response for improved performance. To use compression, include one of the following HTTP headers in the request: Accept-Encoding or Content-Encoding.