Create a Notification Delivery Endpoint

This topic provides information on creating notification delivery endpoints using Oracle Health Clinical Data Exchange.

A notification delivery endpoint is a web address that payers host and use to receive clinical event notifications, such as ADT messages. The following clinical event notifications can be shared with payers:

• Admission or visit notifications (ADT A01)
• Discharge or end visit (ADT A03)
• Register a patient (ADT A04)
• Pre-admit a patient (ADT A05)
• Update patient information (ADT A08)

Oracle Health Clinical Data Exchange uses the URL that you provide to deliver the event notifications. You can create ADT notification delivery endpoints in Oracle Health Clinical Data Exchange.

Note:

You can create up to 25 notification delivery endpoints per tenancy. If you want to use more than 25 notification delivery endpoints, you can request a limit increase using the Limit and Quota Console.

Complete the following steps to create a notification delivery endpoint:

1. With Oracle Health Clinical Data Exchange open, select Notification delivery endpoints in the navigation pane. The Notification Delivery Endpoints page is displayed.
2. Select Create notification delivery endpoint. The Create notification delivery endpoint wizard is displayed.
3. Enter the applicable ADT service URL in the ADT Service URL box.

   Note:

   You cannot update the ADT service URL after you create it. If you need to update it later, you must delete and then re-create it.
4. Select the applicable supported message types (for example, ADT-A03 and ADT-A05) in the Message types supported box.
5. Enter a descriptive name for the endpoint in the Display Name box.
6. Enter a meaningful description of the endpoint in the Description box.
7. Select the compartment in which you want to create the notification delivery endpoint in the Create In Compartment box.
8. Select the applicable CA bundle with which you want to associate the notification delivery endpoint in the Select CA box. Select Change compartment if the CA bundle that you want to select is not associated with the compartment you selected in Step 7.
9. Optionally, select the Enable OAuth 2.0 configuration checkbox. If you select this checkbox, complete the following steps:
   1. Enter the applicable client identifier for OAuth 2.0 authentication in the Client ID box.
   2. Select the applicable vault for the compartment in the Select Vault box. Select Change compartment if the vault that you want to select is not associated with the compartment you selected in Step 7 above.
   3. Select the OCID for the secret that is associated with the client identifier in the Select Secret box. Select Change compartment if the secret that you want to select is not associated with the compartment you selected in Step 7 above.
   4. Select the OCID for the secret that is associated with the client identifier in the Select Secret box. Select Change compartment if the secret that you want to select is not associated with the compartment you selected in Step 7 above.
   5. Enter the URL that is used to request the OAuth 2.0 token in the Token URL box.
   6. Enter the scopes of the OAuth 2.0 authorization in the Scopes box. Enter all the applicable scopes in a comma-separated list format.
   7. Enter the applicable key-value pairs using the Key and Value boxes. Select Add another row and repeat this step as needed to add all the applicable key-value pairs.
10. If you want to use tags, complete the following optional steps:
    1. Select Show advanced options.
    2. Select the applicable tag in the Tag namespace box. If you want to enter a freeform tag, select None (add a free-form tag).
    3. Select the applicable tag key in the Tag key box. If you are entering a freeform tag, enter the tag key that you want to use.
    4. Enter the applicable tag value in the Tag value box.
    5. If you want to add additional tags, select Add tag and repeat the above substeps as needed.
11. Select Create notification delivery endpoint. The Notification delivery endpoint details page is displayed.

After you complete the above steps, the system begins creating the endpoint. Progress is displayed in the Work Requests section. When the endpoint is created, you can view details about the endpoint, edit the endpoint details, add tags, or delete the endpoint.

See the below example of a notification delivery endpoint where xxxxx is the customer-specific environment identifier.

{
      "payerId": "ocid1.cdexhubpayer.oc1.iad.xxxxx",
      "messageType": "ADT",
      "adtEventType": ["ADT-A01","ADT-A03","ADT-A04","ADT-A08"],
      "url": "https://some.customer.hosted.endpoint.org:8443/adt",
      "displayName": "Payer Hosted Delivery Endpoint",
      "description": "delivery endpoint to forward ADTs to from cdex.",
      "compartmentId": "ocid1.compartment.oc1..xxxxx",
      "caBundleId": "ocid1.cabundle.oc1.iad.xxxxx"
}%