Skip to main content

Facilities

A facility is a box of working configuration.

If something should be different between sites, it usually belongs to the facility.

What a facility controls

AreaWhat it means
DoctorsThe doctor profiles that can use Tiep in this facility.
FormsThe forms available for consultations.
Concept setsReusable coded lists used by forms.
API keysKeys used by external systems to call facility endpoints.
Integration settingsWebhook URL, webhook secret, and payload type.
SessionsThe consultation sessions created by doctors or integrations.

When to create more than one facility

Create separate facilities when:

  • Different sites need different API keys.
  • Different departments need different forms.
  • Different clinics send payloads to different webhook URLs.
  • Different teams need restricted access.
  • Quotas or usage should be tracked separately.

Facility API keys

A facility API key is used by external systems for facility-scoped work.

Use it to:

  • Create or update doctor profiles in that facility.
  • Generate a short-lived login token for a doctor.
  • Send audio or transcripts for extraction.
  • Manage public facility forms and concept sets.
  • Poll session or background task status.

Example header:

X-API-Key: tiep_facility_key_value

Facility integration settings

Integration settings tell Tiep what to do when a report is saved.

The settings are:

SettingMeaning
hookThe HTTPS URL Tiep calls when a report is saved.
hook_secretThe secret used to sign the webhook payload.
payload_typeThe payload shape, like SIMPLE or HL7_V2.

Read integration settings for the full flow.