Skip to main content

Doctor profiles

A doctor profile is the doctor identity used in consultations.

It is the clinical identity that stores the doctor name, internal id, email, facility, and specialties.

Why doctor profiles exist

Hospitals usually already have doctor 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 doctor id. Inside Tiep, the profile also receives a stable Tiep id.

Doctor profile vs platform user

ConceptSimple explanation
Doctor profileClinical identity used in visits.
Platform userHuman login for the platform.
InvitationA way to connect a platform user to a doctor profile.

This allows flexible setups:

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

Invitations

Use invitations when a real doctor 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 doctor can access.

Example:

Doctor specialtiesForm specialtyCan use form?
ORTHOPEDICSORTHOPEDICSYes
CARDIOLOGYORTHOPEDICSNo
GENERAL, PEDIATRICSPEDIATRICSYes

This matters for catalogued forms. If the doctor 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"]
}'