Skip to content

Commit

Permalink
hipaa compliance docs (vocodedev#390)
Browse files Browse the repository at this point in the history
* adds hipaa compliance docs

* update hipaa doc
  • Loading branch information
ajar98 authored Sep 8, 2023
1 parent 7eb73e4 commit 54aad44
Show file tree
Hide file tree
Showing 2 changed files with 25 additions and 1 deletion.
23 changes: 23 additions & 0 deletions docs/hipaa-compliance.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
---
title: "HIPAA Compliance"
---

The `hipaa_compliant` flag in the Vocode outbound calls API configures the system to not
persist any potentially sensitive information. Turning on the flag makes the API supportable for use-cases requiring HIPAA compliance.

In particular, turning on the flag:

- Redacts the content of the prompt on the `calls` resource
- Prevents the transcript from being written to the `calls` resource
- Configures the call not to be recorded

# Turning on the flag

```python
vocode_client.calls.create_call(
from_number="<YOUR VOCODE NUMBER>",
to_number="15555555555",
agent=...,
hipaa_compliant=True
)
```
3 changes: 2 additions & 1 deletion docs/mint.json
Original file line number Diff line number Diff line change
Expand Up @@ -173,7 +173,8 @@
"multilingual",
"injecting-context",
"machine-detection",
"ivr-navigation"
"ivr-navigation",
"hipaa-compliance"
]
}
],
Expand Down

0 comments on commit 54aad44

Please sign in to comment.