From 54aad44bba30f0837a79f1509ea03765fd59235b Mon Sep 17 00:00:00 2001
From: Ajay Raj <ajay.n.raj@gmail.com>
Date: Fri, 8 Sep 2023 11:20:11 -0700
Subject: [PATCH] hipaa compliance docs (#390)

* adds hipaa compliance docs

* update hipaa doc
---
 docs/hipaa-compliance.mdx | 23 +++++++++++++++++++++++
 docs/mint.json            |  3 ++-
 2 files changed, 25 insertions(+), 1 deletion(-)
 create mode 100644 docs/hipaa-compliance.mdx

diff --git a/docs/hipaa-compliance.mdx b/docs/hipaa-compliance.mdx
new file mode 100644
index 000000000..c48b4065c
--- /dev/null
+++ b/docs/hipaa-compliance.mdx
@@ -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
+)
+```
diff --git a/docs/mint.json b/docs/mint.json
index b3a1e3ead..c51c218c1 100644
--- a/docs/mint.json
+++ b/docs/mint.json
@@ -173,7 +173,8 @@
         "multilingual",
         "injecting-context",
         "machine-detection",
-        "ivr-navigation"
+        "ivr-navigation",
+        "hipaa-compliance"
       ]
     }
   ],