Integrating Case Visibility

Description

Case Visibility is a feature in Hi Marley that gives carriers the option to mark their Hi Marley cases as either 'Private' or 'Public'. 

This guide will break down how to integrate this feature with our API, if you already use the Open Case and Update Case API call in any integration today. 

If you are new to our integrations, please reference our technical documentation here. As you start to use the Hi Marley API, the below guide will help you ensure that case visibility is a part of your integration.

The visibility options determine who can access Hi Marley cases:

• Public: Anyone in the Carrier organization can access and participate in the case
• Private (shown as private-redacted in our API): Only the assigned Operators and Admins can access and participate in the case

Case Visibility Integration

To integrate case visibility, you will need to do two things:

1. Add the element "privacy" to the Open Case API call for any future case creation. Sample payload is shown in our docs.
   • The options for the "privacy" element are "public" and "private-redacted" (which indicates private)
2. To update any existing Hi Marley cases from an external system and make them private you can use our Update Case API call (PUT /api/case/{caseID})

• • To solely update the visibility setting in the API request the payload will only include the "privacy" data element as shown below

    {
      "privacy": "private-redacted"
    }

• • This Update Case API call can be integrated into any external system to synchronize visibility in Hi Marley with the corresponding visibility indicator from your system (e.g Claims marked as 'private' in ClaimsCenter will also update the linked Hi Marley case to be private via API)