The sections below describe steps necessary to enable different types of integrations between Ocean and your other business information systems in order to automate and streamline information flows:
- HL7 FHIR eReferral APIs to receive referrals and send updates to Ocean using the HL7 FHIR R4 format
- Ocean's Open eReferral APIs to receive referral notifications, retrieve referrals and send updates to Ocean
- Ocean's Open Patient Engagement APIs to create patient-specific Ocean eForms and retrieve them once they are completed.
- A Referral System Launch to redirect to an external website to complete a referral that has been initiated in Ocean.
- An External Data Source to retrieve data from an external endpoint to be integrated in an Ocean eForm.
- External CDS Hooks to integrate with external clinical decision support systems.
Step 1: Setting up a Webhook Endpoint
- From the Admin Settings page, click Integrations> "Register an Integration."
-
- Click on the eReferrals option for the integration type.
-
- For the Payload Type , select the FHIR option.
-
- Name the integration and paste into the Request URL field the URL that Ocean will send the FHIR payloads to.
-
- Select the authentication scheme that Ocean will use to authenticate with your system's endpoint and enter the relevant parameters.
-
- Select the events that Ocean should notify your system about and what actions can be performed once the referral has been sent.
-
Step 2: Linking the Service Directory Listing With an Integration
- From the Admin Settings page, click Directory Listings> tab and open the Advanced section at the bottom of the page.
-
- The integrations specified for the Ocean site will be listed in the Integration field. Select the one that should be linked to this directory listing. Enter the same value into the External Service ID field.
-
Your Ocean site is now ready to send eReferrals to your point-of-service system using the HL7 FHIR eReferral APIs.
Step 3: Generating Ocean OAuth Credentials
Systems must send Ocean a site-specific Client ID and secret in order to receive an OAuth token(s) that can be used to submit referral updates for that Ocean site. To generate the Client ID and secret:
- From the Admin Settings page, click Manage Credentials > Manage OAuth Credentials button.
-
- Add a meaningful name and click the "Add New Credential button."
-
Your Ocean site is now ready to receive eReferrals from your point-of-service system using the HL7 FHIR eReferral APIs.
Step 1: Setting up a Webhook Endpoint
- From the Menu, select Admin and then select Site Features. Activate the "Enable Ocean Cloud Connect" option. This will trigger a dialog instructing you to set up Cloud Connect. Select the "Go to Cloud Connect" button.
-
![](https://www.cognisantmd.com/wp-content/uploads/2022/02/Enable-Cloud-Connect-setting.png")
- In Cloud Connect, select "Store my encryption key". (Do not access the "Integrate with my EMR" option.) Enter the site's SEK and select 'Save'.
-
- From the Admin page, select Integrations> "Register an Integration."
-
- Click on the eReferrals option for the integration type.
-
- Name the integration and paste into the Request URL field the endpoint that Ocean will send the Open API notifications to.
- Select the events that Ocean should notify your system about and what actions can be performed once the referral has been sent.
-
Step 2: Linking the Service Directory Listing With an Integration
- From the Admin Settings page, click Directory Listings> tab and open the Advanced section at the bottom of the page.
-
- The integrations specified for the Ocean site will be listed in the Integration field. Select the one that should be linked to this directory listing. Enter the same value into the External Service ID field.
-
Your Ocean site is now ready to send eReferrals to your point-of-service system and receive updates using the Ocean Open APIs.
Step 1: Setting up a Webhook Endpoint
- From the Menu, select Admin and then select Site Features. Activate the "Enable Ocean Cloud Connect" option. This will trigger a dialog instructing you to set up Cloud Connect. Select the "Go to Cloud Connect" button.
-
- In Cloud Connect, select "Store my encryption key". (Do not access the "Integrate with my EMR" option.) Enter the site's SEK and select 'Save'.
-
- From the Admin Settings page, click Integrations> "Register an Integration."
- Click on the Patient Messages option for the integration type.
-
- Name the integration and paste into the Request URL field the URL that Ocean will send the Open API notifications to.
-
- Select the events that Ocean should notify your system about.
Your Ocean site is now ready to send eForms and receive updates using the Ocean Open APIs.
Configuring a Contextual Launch
- Click the check-box "Activate a Referral System Launch when Sending a Referral" to set up the user display messaging and redirect that will occur.
-
The following fields can be set as part of 'header' and 'footer' that will automatically appear at the top and bottom of the referral form.
- Company Name - of the system that will be launched
- Base launch URL - the URL that the redirect will be sent to
- Application Name
- Category Field
You can optionally set additional advanced settings:
- Referral Form For Associated Listings - Attach a specific referral form that is associated with the listing
- Confirmation Message (Override) - Customize the confirmation message for accepted referrals.
- Logo - Personalize referrals by including a logo
- Use Embedded <iframe> - Enabling this setting will launch the redirect URL in an iframe.
Configuring an External Data Source
- From the Admin Settings page, click Integrations> "Register an Integration."
-
- Select 'External Data Source'.
-
- Specify an 'Integration Name'.
-
-
Specify the 'Request URL'.
The request URL must return data in a JSON format. Ocean will issue an HTTP GET request to this URL upon registration. Requests are then issued whenever the integration is edited, as well as every Sunday night.
- If applicable, specify an Authentication Type and enter the relevant authentication credentials.
- Click 'Save'.
- The integration will be added to the 'External Data Source' table in the main Integrations page. It can be edited or removed at any time using the buttons on the right.
-
Configuring External CDS Hooks
- From the Admin Settings page, click Integrations> "Register an Integration."
-
- Select 'External CDS Hook'.
-
- Specify a 'CDS Hook Name'.
-
-
Specify the 'Base URL'.
The Base URL should be the location of the /cds-services endpoint. For example, if your Discovery endpoint is located at "https://example.com/api/fhir/cds-services" then your Base URL would be "https://example.com/api/fhir".
- If applicable, specify an Authentication Type and enter the relevant authentication credentials.
- Click 'Connect'.
- Use the 'Selected Service' dropdown to choose the type of CDS service (e.g., "order-sign").
-
- Use the 'Associated Directory Listings' dropdown to choose the Directory Listing(s) that will trigger the CDS hook at the time of referral send.
- Click 'Save'.
- The integration will be added to the 'External CDS Hooks' table in the main Integrations page where it can be edited or removed.