Translate patient instructions
POST/translate-patient-instructions
Translates already-generated patient instructions into another language, so they can be handed to the patient in the language they are most comfortable with.
When a translation is performed, the response appends a short disclaimer, in the target language, stating that the text was machine-translated.
Provider review
Translations are produced automatically. A licensed healthcare provider should review and approve them before sharing with the patient.
Use POST /generate-patient-instructions to produce the instructions in the first place.
Request
Responses
- 200
The translated patient instructions.
Operation spec
{
"method": "post",
"path": "/translate-patient-instructions",
"operationId": "translate-patient-instructions",
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"description": "The input to translate the patient instructions.",
"properties": {
"instructions": {
"type": "string",
"minLength": 1,
"description": "The patient instructions to translate, as returned by `POST /generate-patient-instructions`.",
"example": "- Order a sleep test that you can do at home. This will help us understand more about how you sleep.\n- After you've done the sleep test, we'll talk about the results in our next meeting."
},
"current_locale": {
"description": "Locale the patient instructions are currently written in. This value is not validated against the text; it is passed to the model as the declared source locale.",
"type": "string",
"enum": [
"ENGLISH_US",
"ENGLISH_UK",
"SPANISH_ES",
"SPANISH_MX",
"FRENCH_FR",
"ARABIC_EG",
"ARABIC_LB",
"ARABIC_MA",
"ARABIC_SA",
"ARMENIAN_AM",
"BENGALI_IN",
"CANTONESE_CN",
"CROATIAN_HR",
"FILIPINO_PH",
"GERMAN_DE",
"GREEK_GR",
"GUJARATI_IN",
"HEBREW_IL",
"HINDI_IN",
"ITALIAN_IT",
"JAPANESE_JP",
"KHMER_KH",
"KOREAN_KR",
"MANDARIN_CN",
"PERSIAN_IR",
"POLISH_PL",
"PORTUGUESE_PT",
"PUNJABI_IN",
"RUSSIAN_RU",
"SERBIAN_RS",
"TAMIL_IN",
"TELUGU_IN",
"THAI_TH",
"URDU_IN",
"VIETNAMESE_VN",
"HAITIAN_HT"
],
"example": "ENGLISH_US",
"title": "speech_locale"
},
"new_locale": {
"description": "Locale to translate the patient instructions into. When it is exactly equal to `current_locale`, nothing is translated: the instructions are returned unchanged, without a translation disclaimer. Locale variants of the same language (for example `SPANISH_ES` and `SPANISH_MX`) are not equal, and are translated.",
"type": "string",
"enum": [
"ENGLISH_US",
"ENGLISH_UK",
"SPANISH_ES",
"SPANISH_MX",
"FRENCH_FR",
"ARABIC_EG",
"ARABIC_LB",
"ARABIC_MA",
"ARABIC_SA",
"ARMENIAN_AM",
"BENGALI_IN",
"CANTONESE_CN",
"CROATIAN_HR",
"FILIPINO_PH",
"GERMAN_DE",
"GREEK_GR",
"GUJARATI_IN",
"HEBREW_IL",
"HINDI_IN",
"ITALIAN_IT",
"JAPANESE_JP",
"KHMER_KH",
"KOREAN_KR",
"MANDARIN_CN",
"PERSIAN_IR",
"POLISH_PL",
"PORTUGUESE_PT",
"PUNJABI_IN",
"RUSSIAN_RU",
"SERBIAN_RS",
"TAMIL_IN",
"TELUGU_IN",
"THAI_TH",
"URDU_IN",
"VIETNAMESE_VN",
"HAITIAN_HT"
],
"example": "ENGLISH_US",
"title": "speech_locale"
}
},
"required": [
"instructions",
"current_locale",
"new_locale"
],
"title": "translate_patient_instructions_request"
}
}
}
},
"responses": {
"200": {
"description": "The translated patient instructions.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"instructions": {
"type": "string",
"description": "The translated instructions for the patient, followed by a machine-translation disclaimer written in the target locale.",
"example": "- Solicite una prueba de sueño que pueda hacer en casa. Esto nos ayudará a entender mejor cómo duerme.\n- Después de que se haya hecho la prueba de sueño, hablaremos de los resultados en nuestra próxima consulta.\n\nAviso: esta es una traducción automática. Por favor, revísela con su médico si tiene preguntas o dudas."
}
},
"required": [
"instructions"
],
"title": "translate_patient_instructions_response"
}
}
}
}
}
}