PREREQUISITES
Confirm Administrator Access
Ensure that at least one user on your Ocean site has administrator privileges, as these permissions are required for integration setup.
Identify Your Ocean Site ID
Your Ocean Site ID is essential for future troubleshooting and ensuring proper integration.
How to locate your Ocean Site ID:
Log into Ocean
Find your Site ID in the top-right corner of the screen
Share this ID with Caredove for future troubleshooting
Identify Ocean Directory Listings for Integration
Determine which Ocean directory listings will be integrated with Caredove service listings. Ensure the listings exist before proceeding.
In Ocean:
Navigate to "Menu" > "Admin"
Click on "Directory Listings"
Locate each service you want to integrate with Caredove
Obtain Integration Credentials from Caredove
Caredove will provide the necessary integration credentials. Your organization is responsible for securely storing and managing these credentials.
CONFIGURATION STEPS
Step 1: Configure the Integration Settings
Set up the integration properties by following these steps:
In Ocean:
Go to "Admin" > "Integrations"
Click on "Register an Integration" and select "eReferrals"
In the dialog box, enter the following details:
Integration Name: Caredove
Webhook Endpoint - Request URL:
fhir.caredove.com/MessageHeader/$process-messagePayload Type: FHIR v0.10.0
Select "HTTP Basic Authentication"
Username & Password: Enter the credentials provided by Caredove
Email Notifications: Select your preferred options, considering existing notifications in Caredove to avoid duplicates
Attachments: Enable or disable the "Prevent referral senders from including attachments" option based on your referral requirements
Permissions: Leave the remaining checkboxes under the "Permissions" section unchecked
Click "Save Changes" to complete this step.
Step 2: Identify Caredove Service Listings for Integration
Determine which Caredove service listings will be integrated with Ocean.
In Caredove:
Navigate to your organization’s profile
Click on "Listings"
Locate each service you want to integrate
For each service in scope, identify the Caredove Service Listing ID:
The ID appears in the service URL as:
The XXXXX represents the Caredove Service ID. Note this for mapping in Ocean
Step 3: Map Ocean Listings to Caredove Services
In Ocean:
Navigate to "Admin" > "Directory Listings"
For each service being integrated:
Go to "Advanced"
Under "Integration", select "Caredove"
In "External Service ID", enter the following URL: http://fhir.caredove.com/HealthcareService/XXXXX (replace XXXXX with the Caredove Service ID identified earlier)
Under "Resubmission Restrictions", enable "Prevent senders from resubmitting referrals"
If supporting attachments, disable "Prevent referral senders from including attachments" under "Submission Settings"
Click "Save Changes"
Step 4: Generate Ocean OAuth 2.0 Credentials for Caredove (If Supporting Attachments)
If attachments are supported in your referrals, create dedicated OAuth 2.0 credentials for Caredove. These credentials should not be shared with other integration partners.
In Ocean:
Navigate to "Admin" > "Manage Credentials"
Click on "Manage OAuth Credentials"
Enter your Shared Encryption Key
Enter a credential name (e.g., "Caredove Credentials") and click "Add New Credential"
Securely share the Client ID and Secret values with Caredove
Caredove will configure this credentials on their site.
IMPORTANT NOTES
To disable the integration, go to "Admin" > "Listings" > "Advanced", and select "None selected" under integration settings.
Service updates (e.g., descriptions, hours of operation) must be manually updated on both Ocean and Caredove to ensure consistency.
By following these steps, your Ocean site will be successfully integrated with Caredove, enabling smooth referral submissions.
If you encounter any issues, please consult your Caredove representative or reach out to support for assistance.