Professional profiles

A professional profile is the clinical identity used in consultations.

It stores the professional's name, internal id, email, facility, and specialties.

Doctors, nurses, physiotherapists, and any other clinician who runs a consultation all use the same kind of profile. The API still calls it a doctor, so you will see doctor in endpoints and field names throughout this guide.

Why professional profiles exist

Hospitals usually already have their own staff IDs. Tiep keeps those IDs as internal_id.

Example:

{
  "id": "doctor-123",
  "name": "Dr. Anna Smith",
  "email": "[email protected]",
  "specialties": ["Orthopedics"]
}

In the API, id is the hospital's own id for that person. Inside Tiep, the profile also receives a stable Tiep id.

Professional profile vs platform user

Concept	Simple explanation
Professional profile	Clinical identity used in visits.
Platform user	Human login for the platform.
Invitation	A way to connect a platform user to a professional profile.

This allows flexible setups:

• A hospital can create professional profiles by API before anyone signs in.
• A professional can later accept an invitation and claim their profile.
• The same profile keeps its consultation history.

Invitations

Use invitations when a real professional should log in and own their profile.

Flow:

Rules:

• A profile that already has an owner cannot be invited again.
• Accepting one invitation revokes other pending invitations for that profile.
• The invited email must match the signed-in user's email.

Specialties

Specialties decide which catalogued forms a professional can access. Each facility owns and manages its own specialty list, so API values must match specialty names in that facility.

Example:

Professional specialties	Form specialty	Can use form?
Orthopedics	Orthopedics	Yes
Cardiology	Orthopedics	No
General medicine, Pediatrics	Pediatrics	Yes

This matters for catalogued forms. If the professional has no matching specialty, the form is hidden from their available forms.

Updating specialties

Use specialties when you want catalogued forms to be filtered automatically.

curl -X PATCH "https://api.tiep.ai/v1/doctors/{doctor_id}/specialties" \
  -H "X-API-Key: $FACILITY_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "specialties": ["Orthopedics", "Sports medicine"]
  }'

Specialty names are matched case-insensitively, but using the label returned by the facility specialty list keeps integrations readable and avoids stale names after a rename.