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.
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
Open API Data Descriptions
The file below lists the data elements that are available within the Open API payloads: