Skip to content

Commit 595931d

Browse files
committed
chore: Added Section for HIPPA Enabled Orgs
1 parent b4a8e70 commit 595931d

File tree

2 files changed

+18
-4
lines changed

2 files changed

+18
-4
lines changed

fern/assistants/structured-outputs-quickstart.mdx

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -638,14 +638,16 @@ You can attach multiple structured outputs to extract different types of data:
638638
{
639639
artifactPlan: {
640640
structuredOutputIds: [
641-
customerInfoId, // Extract customer details
642-
appointmentId, // Extract appointment requests
643-
feedbackId // Extract satisfaction feedback
641+
"550e8400-e29b-41d4-a716-446655440001", // Customer details extraction
642+
"550e8400-e29b-41d4-a716-446655440002", // Appointment requests extraction
643+
"550e8400-e29b-41d4-a716-446655440003" // Satisfaction feedback extraction
644644
]
645645
}
646646
}
647647
```
648648
649+
<Note>The `structuredOutputIds` are UUIDs returned when you create each structured output configuration.</Note>
650+
649651
### Conditional extraction
650652
651653
Use conditional logic in your schema to handle different scenarios:

fern/assistants/structured-outputs.mdx

Lines changed: 13 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -756,9 +756,21 @@ if (data.result === null) {
756756
### Partial extraction
757757
758758
- Make fields optional if they might not be mentioned
759-
- Check if schema complexity exceeds limits
760759
- Verify data types match expected values
761760
761+
## HIPAA compliance
762+
763+
<Warning>
764+
**Important for HIPAA-enabled organizations:**
765+
766+
If your organization has HIPAA compliance enabled (`hipaaEnabled: true`), structured outputs are **disabled by default** to protect PHI (Protected Health Information).
767+
768+
To use structured outputs with HIPAA compliance:
769+
- Contact the Vapi team to enable structured outputs
770+
- Ensure you understand the implications for PHI handling
771+
- Follow all HIPAA compliance best practices when extracting sensitive health data
772+
</Warning>
773+
762774
## Limitations
763775
764776
<Warning>

0 commit comments

Comments
 (0)