TEtelepatia
Appointments

Create an appointment

Create a scheduled consultation (idempotent on consultationInternalId).

Required: consultationInternalId, start, end, plus exactly one patient reference: patientId, internalCode, or the full inline identity (name + idCountry + idType + idValue).

Optional: the remaining scheduling fields (minutesDuration, serviceType, appointmentType, reason, description) and a template (medicalRecordConfigurationId) that seeds the consultation context before the visit.

Returns the appointment with its stable public id (apt_...).

post/v1/appointments

Request

  • Base URL
    https://scribe-api.telepatia.ai
  • Auth
    HTTP bearer

Request body

consultationInternalIdstring required

Your own consultation id. The booking join key: the consultation that fulfils this appointment carries the same id.

namestring nullable

Patient full name. Part of the inline identity. Provide the full inline identity (name + idCountry + idType + idValue), or reference an existing patient with patientId or internalCode: exactly one of the three is required.

idCountry'AF' | 'AX' | 'AL' | 'DZ' | 'AS' | 'AD' | 'AO' | 'AI' | 'AQ' | 'AG' | 'AR' | 'AM' | 'AW' | 'AU' | 'AT' | 'AZ' | 'BS' | 'BH' | 'BD' | 'BB' | 'BY' | 'BE' | 'BZ' | 'BJ' | 'BM' | 'BT' | 'BO' | 'BQ' | 'BA' | 'BW' | 'BV' | 'BR' | 'IO' | 'BN' | 'BG' | 'BF' | 'BI' | 'KH' | 'CM' | 'CA' | 'CV' | 'KY' | 'CF' | 'TD' | 'CL' | 'CX' | 'CC' | 'CO' | 'KM' | 'CK' | 'CR' | 'CI' | 'HR' | 'CU' | 'CW' | 'CY' | 'CZ' | 'CD' | 'DK' | 'DJ' | 'DM' | 'DO' | 'EC' | 'EG' | 'SV' | 'GQ' | 'ER' | 'EE' | 'SZ' | 'ET' | 'FK' | 'FO' | 'FJ' | 'FI' | 'FR' | 'GF' | 'PF' | 'TF' | 'GA' | 'GE' | 'DE' | 'GH' | 'GI' | 'GR' | 'GL' | 'GD' | 'GP' | 'GU' | 'GT' | 'GG' | 'GN' | 'GW' | 'GY' | 'HT' | 'HM' | 'VA' | 'HN' | 'HK' | 'HU' | 'IS' | 'IN' | 'ID' | 'IQ' | 'IE' | 'IR' | 'IM' | 'IL' | 'IT' | 'JM' | 'JP' | 'JE' | 'JO' | 'KZ' | 'KE' | 'KI' | 'XK' | 'KW' | 'KG' | 'LA' | 'LV' | 'LB' | 'LS' | 'LR' | 'LY' | 'LI' | 'LT' | 'LU' | 'MO' | 'MG' | 'MW' | 'MY' | 'MV' | 'ML' | 'MT' | 'MH' | 'MQ' | 'MR' | 'MU' | 'YT' | 'MX' | 'FM' | 'MD' | 'MC' | 'MN' | 'ME' | 'MS' | 'MA' | 'MZ' | 'MM' | 'NA' | 'NR' | 'NP' | 'NL' | 'NC' | 'NZ' | 'NI' | 'NE' | 'NG' | 'NU' | 'NF' | 'KP' | 'MP' | 'NO' | 'OM' | 'PK' | 'PW' | 'PA' | 'PG' | 'PY' | 'CN' | 'PE' | 'PH' | 'PN' | 'PL' | 'PT' | 'PR' | 'QA' | 'CG' | 'GM' | 'RE' | 'RO' | 'RU' | 'RW' | 'BL' | 'SH' | 'KN' | 'LC' | 'MF' | 'PM' | 'VC' | 'WS' | 'SM' | 'ST' | 'SA' | 'SN' | 'RS' | 'SC' | 'SL' | 'SG' | 'SX' | 'SK' | 'SI' | 'SB' | 'SO' | 'ZA' | 'GS' | 'KR' | 'SS' | 'ES' | 'LK' | 'PS' | 'SD' | 'SR' | 'SJ' | 'SE' | 'CH' | 'SY' | 'TW' | 'TJ' | 'TH' | 'MK' | 'TL' | 'TG' | 'TK' | 'TO' | 'TT' | 'TN' | 'TR' | 'TM' | 'TC' | 'TV' | 'UG' | 'UA' | 'AE' | 'GB' | 'TZ' | 'UM' | 'US' | 'UY' | 'UZ' | 'VU' | 'VE' | 'VN' | 'VG' | 'VI' | 'WF' | 'EH' | 'YE' | 'ZM' | 'ZW'

ISO 3166-1 alpha-2 country codes. Mirrors tanjiro's CountryCodes enum.

idType'CC' | 'TI' | 'CE' | 'RC' | 'PASSPORT' | 'RG' | 'CPF' | 'OTHER_DOC'

Supported patient identification document types.

idValuestring nullable

Patient document number. Part of the inline identity (see name).

patientIdstring nullable

Public id of an existing patient (sp_...). One of the three patient references (exactly one required): patientId, internalCode, or the inline identity.

internalCodestring nullable

Your own patient code, unique per institution. Looks up an existing patient; when none matches, the inline identity creates one. One of the three patient references (exactly one required).

doctorIdstring nullable

The doctor whose agenda this booking joins: an account publicId (acc_...) or your own internalCode for that account. Omit it to book into the calling key's own agenda. Naming another account requires an institutional key; a doctor key always books for itself.

startstring required

ISO-8601 start. Required.

endstring required

ISO-8601 end. Required.

minutesDurationinteger nullable

Duration in minutes.

serviceTypestring nullable
appointmentTypestring nullable
reasonstring nullable
descriptionstring nullable
medicalRecordConfigurationIdstring nullable

Public id of a medical record configuration (mrc_...). When present, the consultation context is seeded.

scribeSessionModality'IN_PERSON' | 'TELEMEDICINE' | 'DICTATION'

Supported scribe session modalities.

notesstring nullable
pastMedicalHistorystring nullable

Example request

{
  "consultationInternalId": "CONSULT-12345",
  "end": "2026-09-01T14:30:00.000Z",
  "idCountry": "COLOMBIA",
  "idType": "CC",
  "idValue": "1024567890",
  "medicalRecordConfigurationId": "mrc_a1b2c3d4e5f6g7h8",
  "name": "John Doe",
  "reason": "Follow-up",
  "scribeSessionModality": "IN_PERSON",
  "serviceType": "cardiology",
  "start": "2026-09-01T14:00:00.000Z"
}

Response

Successful Response

idstring required

Stable public identifier.

consultationInternalIdstring nullable
statusstring required
startstring nullable
endstring nullable
minutesDurationinteger nullable
serviceTypestring nullable
appointmentTypestring nullable
reasonstring nullable
descriptionstring nullable
scribeSessionModality'IN_PERSON' | 'TELEMEDICINE' | 'DICTATION'

Supported scribe session modalities.

medicalRecordConfigurationIdstring nullable

The template the booking opens on. Null when the booking names none, or when the template has been deleted since.

createdAtstring required

ISO-8601 timestamp when the appointment was created.

Example response

{
  "appointmentType": "follow-up",
  "consultationInternalId": "CONSULT-12345",
  "createdAt": "2026-08-28T12:00:00.000Z",
  "end": "2026-09-01T14:30:00.000Z",
  "id": "apt_a1b2c3d4e5f6g7h8",
  "medicalRecordConfigurationId": "mrc_a1b2c3d4e5f6g7h8",
  "minutesDuration": 30,
  "reason": "Follow-up",
  "scribeSessionModality": "TELEMEDICINE",
  "serviceType": "cardiology",
  "start": "2026-09-01T14:00:00.000Z",
  "status": "booked"
}

Changes

No recorded changes to this operation across all 1 revision of this API.