Custom Ocean Integrations

You can set up several types of integrations between Ocean and your other business information systems to automate and streamline information flows:

  • Registering a Webhook Endpoint  enables Ocean to send notifications to other systems when important events occur.
  • Referral System Launch notifies the user that a redirect to an external website will occur after a referral has been completed in Ocean.

Setting up a Webhook Endpoint

    • Click the Admin View > Integrations> "Register an Integration."
    • Select whether the notification is related to a patient engagement module (e.g Patient Messages) or eReferrals.
    • Name the integration.
    • Paste the URL that Ocean will send updates to regarding the status of an event that occurred within Ocean. For details on the validation process of this URL, see here: Webhook Endpoint Validation.
    • Select the events that Ocean should notify your system about.

Referral Payload Format Options

    • Ocean eReferral payloads can be sent in Ocean's proprietary JSON format or as a HL7 FHIR R4 resource bundle.  



Referral System 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
  • Catogory 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.

Implementation Guidance

Ocean's Open APIs enable third-party systems to integrate with Ocean so that providers and patients can securely complete forms and process referrals within their preferred system or app.  In addition to the Open API documentation, we have assembled the following implementation guidance to accelerate your integration implementation.


Patient Engagement eForm Integration Sequence

The sequence diagram below illustrates the interaction sequence between Ocean and a third-party system to generate patient-specific weblinks that can be embedded in the third-party system's secure messaging service.   The patient will access the weblink to complete Ocean eForms, after which Ocean will notify the third-party system to collect the completed forms.




eReferral Integration Sequence

The sequence diagram below illustrates the interaction sequence between Ocean and a third-party system after a referral has been created in Ocean.   





Webhook Validation

The webhook requires the URL to respond to a challenge in order for it to work properly.   Testing with a webhook that is not ready to provide the challenge token in the response will fail validation.

For additional information, please see our API Docs


Payload Encryption

The encryption code in the Ocean API documentation is an example that illustrates the correct encryption flow and highlights the encryption library (CryptoJS) we use and recommend when working in Javascript.  But the encryption scheme is just standard AES encryption so you will absolutely be able to encrypt/decrypt this data in other languages. For instance, For Ruby, you can use the OpenSSL module in the standard library to run the AES ciphers to encrypt and decrypt the data.  There are also likely other external AES/cryptography gems you can use if you have a preference.


Open API Data Descriptions

The file below lists the data elements that are available within the Open API payloads: