REST APIs for Oracle Health Clinical Data Exchange

All REST Endpoints

Binary

Get a binary document by ID: Method: get
Path: /fhir/r4/{query_endpoint_alias}/Binary/{id}

DocumentReference

Get a document reference by ID: Method: get
Path: /fhir/r4/{query_endpoint_alias}/DocumentReference/{id}
Get a list of document references: Method: get
Path: /fhir/r4/{query_endpoint_alias}/DocumentReference

Patient

Get a patient list: Method: get
Path: /fhir/r4/{query_endpoint_alias}/Patient
Get a patient record by ID: Method: get
Path: /fhir/r4/{query_endpoint_alias}/Patient/{id}

Task

Create a new Task resource: Method: post
Path: /fhir/r4/{query_endpoint_alias}/Task
Get a Task resource by ID: Method: get
Path: /fhir/r4/{query_endpoint_alias}/Task/{id}

cdexHub

The operations from the cdexHub category.

Cancel work requests: Method: delete
Path: /20180828/workRequests/{workRequestId}
Create a DeliveryEndpoint: Method: post
Path: /20180828/deliveryEndpoints
Create a QueryEndpoint: Method: post
Path: /20180828/queryEndpoints
Delete a DeliveryEndpoint: Method: delete
Path: /20180828/deliveryEndpoints/{deliveryEndpointId}
Delete a QueryEndpoint: Method: delete
Path: /20180828/queryEndpoints/{queryEndpointId}
Get a DeliveryEndpoint: Method: get
Path: /20180828/deliveryEndpoints/{deliveryEndpointId}
Get a list of DataSharingAgreements: Method: get
Path: /20180828/dataSharingAgreements
Get a list of DataSharingConstraints: Method: get
Path: /20180828/dataSharingConstraints
Get a list of DeliveryEndpoints: Method: get
Path: /20180828/deliveryEndpoints
Get a list of PayerDirectoryEntries: Method: get
Path: /20180828/payerDirectoryEntries
Get a list of Payers: Method: get
Path: /20180828/payers
Get a list of ProviderDirectoryEntries: Method: get
Path: /20180828/providerDirectoryEntries
Get a list of QueryEndpoints: Method: get
Path: /20180828/queryEndpoints
Get a Payer: Method: get
Path: /20180828/payers/{payerId}
Get a PayerDirectoryEntry: Method: get
Path: /20180828/payerDirectoryEntries/{payerDirectoryEntryId}
Get a QueryEndpoint: Method: get
Path: /20180828/queryEndpoints/{queryEndpointId}
Get work request status: Method: get
Path: /20180828/workRequests/{workRequestId}
List work request errors: Method: get
Path: /20180828/workRequests/{workRequestId}/errors
List work request logs: Method: get
Path: /20180828/workRequests/{workRequestId}/logs
List work requests: Method: get
Path: /20180828/workRequests
Move the DeliveryEndpoint into a different compartment: Method: post
Path: /20180828/deliveryEndpoints/{deliveryEndpointId}/actions/changeCompartment
Move the QueryEndpoint into a different compartment: Method: post
Path: /20180828/queryEndpoints/{queryEndpointId}/actions/changeCompartment
Test DeliveryEndpoint connectivity: Method: post
Path: /20180828/deliveryEndpoints/{deliveryEndpointId}/actions/testConnectivity
Update a DeliveryEndpoint: Method: put
Path: /20180828/deliveryEndpoints/{deliveryEndpointId}
Update a PayerDirectoryEntry: Method: put
Path: /20180828/payerDirectoryEntries/{payerDirectoryEntryId}
Update a QueryEndpoint: Method: put
Path: /20180828/queryEndpoints/{queryEndpointId}