Translate clinical note

Intelligently generates the translation of the clinical note into the specified language.

Below we describe the entire process that enables the successful completion of the clinical note translation.

Request description

Available since API version: 2025-11-01

Endpoint: /api/v1/translate-clinical-note
Method: POST

Remember: you can see the URL to consume this API in the Introduction section.

{
  "Content-Type": "application/json",
  "Authorization": "Bearer <accessToken>"
}

Authorization: We'll pass the token obtained during the authentication process. You can reuse the generated tokens, as they have a 2-hour lifespan. Review this page: Credentials

To set the API version on a specific request, you can add a specific header named X-Invox-Medical-Api-Version with the value of the version you are targeting:

X-Invox-Medical-Api-Version: 2025-11-01

Payload structure

type APITranslateTranscriptionRequest = {
  clinicalNote: IClinicalNoteField[];
  targetLanguage: string;
};

interface IClinicalNoteField {
  id: string;
  name: string;
  type: string | number | boolean | string[];
  value: TemplateFieldDataType;
}

type TemplateFieldDataType = string | string[] | number | boolean;

Responses

Correct response

Successful request

Describe the characteristics of a satisfactory response

200

Response example:

{
  "translatedFields": [
    {
      "id": "field1",
      "name": "Patient's chief complaint",
      "type": "string",
      "value": "The patient has been experiencing headaches for the past 3 days, with episodes of nausea and sensitivity to light."
    },
    {
      "id": "field2",
      "name": "History of present illness",
      "type": "string",
      "value": "The patient has been experiencing headaches for the past 3 days, with episodes of nausea and sensitivity to light."
    }
  ]
}
Response structure
type TranslateClinicalNoteResponse = {
  translatedFields: IClinicalNoteField[];
};

Wrong responses

Unauthorized request

Describes the response when the request is not authorized


401

Response body

type TranslateClinicalNoteResponse = {
  messsage: string;
};


Forbidden request

Describes the response when the API Key is not allowed to consume this service


403

Response body

type TranslateClinicalNoteResponse = {
  messsage: string;
  errorType: string;
};


Bad request

Describe the features of a bad request

400

Response body

type TranslateClinicalNoteResponse = {
    messsage: string;
    errorType: TRANSLATE_CLINICAL_NOTE_ERROR_TYPE;
}

enum TRANSLATE_CLINICAL_NOTE_ERROR_TYPE {
   INVALID_LANGUAGE= 'invalidLanguage'
   EMPTY_LANGUAGE= 'emptyLanguage'
   INVALID_REPORT_FIELD = 'invalidReportField',
   EMPTY_REPORT_FIELD = 'emptyReportField',
   INVALID_API_VERSION_FOR_ENDPOINT = 'invalidApiVersionForEndpoint'
}

Internal server error

Describe the features of an internal server error

500

Response body

type TranslateClinicalNoteInternalErrorResponse = {
  messsage: string;
  errorType: "errorGeneratingTranslateClinicalNote";
};

Please remember, for a successful translation, the target language must be one of the supported languages listed below:
export const SUPPORTED_LANGUAGES = [
  "af", // Afrikaans
  "sq", // Albanian
  "am", // Amharic
  "ar", // Arabic
  "hy", // Armenian
  "as", // Assamese
  "az", // Azerbaijani
  "eu", // Basque
  "be", // Belarusian
  "bn", // Bengali
  "bs", // Bosnian
  "bg", // Bulgarian
  "ca", // Catalan
  "zh", // Chinese
  "hr", // Croatian
  "cs", // Czech
  "da", // Danish
  "nl", // Dutch
  "en", // English
  "et", // Estonian
  "fi", // Finnish
  "fr", // French
  "gl", // Galician
  "ka", // Georgian
  "de", // German
  "el", // Greek
  "gu", // Gujarati
  "ht", // Haitian Creole
  "ha", // Hausa
  "haw", // Hawaiian
  "he", // Hebrew
  "hi", // Hindi
  "hmn", // Hmong
  "hu", // Hungarian
  "is", // Icelandic
  "ig", // Igbo
  "id", // Indonesian
  "ga", // Irish
  "it", // Italian
  "ja", // Japanese
  "jv", // Javanese
  "kn", // Kannada
  "kk", // Kazakh
  "km", // Khmer
  "ko", // Korean
  "ku", // Kurdish
  "ky", // Kyrgyz
  "lo", // Lao
  "lv", // Latvian
  "lt", // Lithuanian
  "lb", // Luxembourgish
  "mk", // Macedonian
  "mg", // Malagasy
  "ms", // Malay
  "mt", // Maltese
  "mi", // Maori
  "mr", // Marathi
  "mni", // Manipuri (Meitei)
  "mn", // Mongolian
  "my", // Myanmar (Burmese)
  "ne", // Nepali
  "ny", // Chichewa
  "no", // Norwegian
  "or", // Odia
  "ps", // Pashto
  "fa", // Persian
  "pl", // Polish
  "pt", // Portuguese
  "pa", // Punjabi
  "qu", // Quechua
  "ro", // Romanian
  "ru", // Russian
  "sm", // Samoan
  "sa", // Sanskrit
  "gd", // Scottish Gaelic
  "sr", // Serbian
  "st", // Sesotho
  "sn", // Shona
  "sd", // Sindhi
  "si", // Sinhala
  "sk", // Slovak
  "sl", // Slovenian
  "so", // Somali
  "es", // Spanish
  "su", // Sundanese
  "sw", // Swahili
  "sv", // Swedish
  "tg", // Tajik
  "ta", // Tamil
  "te", // Telugu
  "th", // Thai
  "tr", // Turkish
  "uk", // Ukrainian
  "ur", // Urdu
  "ug", // Uyghur
  "uz", // Uzbek
  "vi", // Vietnamese
  "xh", // Xhosa
  "yi", // Yiddish
  "yo", // Yoruba
  "zu", // Zulu
  "va", // Valencian
];

Table of Contents