Parámetros de los endpoints

Para simplificar el proceso de integración para los equipos técnicos, hemos desarrollado un conjunto de endpoints auxiliares que agilizan el acceso a datos relevantes. Estos endpoints proporcionan una recuperación rápida y eficiente de la información necesaria para conectar y facilitar la interacción entre los endpoints diagnostic-support y severity-assessment, minimizando la cantidad de código adicional requerido por el integrador.

Endpoint de sitios del cuerpo

Este endpoint auxiliar devuelve una lista estandarizada de códigos de sitios del cuerpo utilizados para especificar la ubicación de una patología en el cuerpo humano. Estos códigos son esenciales para definir con precisión el área afectada al interactuar con el endpoint diagnostic-support.

https://medical-device-params.legit.health/v2.0/body-sites

Endpoint de signos clínicos

Este endpoint auxiliar proporciona una lista estandarizada de signos clínicos, incluyendo traducciones multilingües de las claves de signos visuales devueltas por el endpoint severity-measurement.

https://medical-device-params.legit.health/v2.0/clinical-signs

Endpoint de cuestionarios

Cada patología o condición puede estar asociada con ninguno, uno o múltiples sistemas de puntuación. Estos sistemas de puntuación pueden calcularse automáticamente mediante el análisis de modelos de IA de la imagen o, en algunos casos, pueden requerir respuestas a preguntas específicas del paciente o del médico. El endpoint severity-assessment, detallado en la sección Especificación de endpoints, activa el cálculo de estos sistemas de puntuación.

Este endpoint ayuda a:

• Identificar si algún sistema de puntuación está asociado con una patología o condición en particular y, de ser así, proporcionar los detalles del sistema de puntuación.

• En los casos en que un sistema de puntuación esté asociado, si se involucran cuestionarios, el endpoint también proporciona la información necesaria relacionada con las preguntas, incluido el contenido de las preguntas y las opciones de respuesta disponibles.

Proporcionando el parámetro de consulta pathology con un código ICD-11 (por ejemplo, EA90 para Psoriasis), los usuarios pueden obtener sistemas de puntuación y cuestionarios relevantes adaptados a la patología o condición.

Ejemplo:

https://medical-device-params.legit.health/v2.0/questionnaires?pathology=EA90

Solicitud

https://medical-device-params.legit.health/v2.0/questionnaires?pathology=EA90

Parámetros de la solicitud

• pathology (obligatorio): El código ICD-11 que representa la patología específica para la cual se necesita el cuestionario. Por ejemplo, EA90 representa Psoriasis.

Info

Este código ICD-11 será devuelto por el endpoint diagnostic-support. Consulta la sección Especificación de endpoints para más detalles sobre cómo recuperar códigos de patologías/condiciones.

Respuesta

La API responde con un objeto JSON que contiene uno o más cuestionarios pertinentes a la patología especificada. Estos cuestionarios están diseñados para recopilar información estandarizada que ayuda en la evaluación y el monitoreo de la condición.

Claves relevantes en el cuerpo de la respuesta

[
  {
    "identifier": "apasiLocal",
    "code": "apasi",
    "mode": "local",
    "path": "/severity-assessment/image-based/local",
    "title": {
      "en_GB": "Local automatic psoriasis area and severity index",
      "es_ES": "Índice automático de gravedad y área de psoriasis local"
    },
    "description": {
      "en_GB": "Clinical tool for a precise psoriasis severity assessment",
      "es_ES": "Herramienta clínica para determinar la gravedad de la psoriasis"
    },
    "questionnaire": [
      {
        "code": "surface",
        "name": {
          "en_GB": "Affected area",
          "es_ES": "Área afectada"
        },
        "description": {
          "en_GB": "This value corresponds to the percentage of involvement of the specific area of the body you are reporting",
          "es_ES": "Este valor corresponde al porcentaje de afectación de la zona concreta del cuerpo que estás reportando"
        },
        "input": {
          "type": "number",
          "min": 0,
          "max": 100
        }
      }
    ]
  },
  {
    "identifier": "pure4",
    "code": "pure4",
    "mode": "global",
    "path": "/severity-assessment/text-based",
    "title": {
      "en_GB": "Psoriatic arthritis UnclutteRed screening Evaluation",
      "es_ES": "Cuestionario de evaluación de la artritis psoriásica"
    },
    "description": {
      "en_GB": "The aim of this questionnaire is to do an screening of psoriatic arthritis",
      "es_ES": "El propósito de este cuestionario es realizar un cribado de pacientes con artritis psoriásica"
    },
    "questionnaire": [
      {
        "code": "question1",
        "name": {
          "en_GB": "Have you ever had a globally swollen and painful finger or toe?",
          "es_ES": "¿Ha tenido alguna vez dolor e hinchazón/inflamación que afectara a todo un dedo de la mano o del pie?"
        },
        "description": { "en_GB": "", "es_ES": "" },
        "input": {
          "type": "select",
          "options": [
            { "label": { "en_GB": "No", "es_ES": "No" }, "value": "0" },
            { "label": { "en_GB": "Yes", "es_ES": "Sí" }, "value": "1" }
          ]
        }
      },
      {
        "code": "question2",
        "name": {
          "en_GB": "Have you ever had heel pain as soon as you stand up in the morning?",
          "es_ES": "¿Ha tenido o notado alguna vez dolor en el talón al ponerse de pie por la mañana?"
        },
        "description": { "en_GB": "", "es_ES": "" },
        "input": {
          "type": "select",
          "options": [
            { "label": { "en_GB": "No", "es_ES": "No" }, "value": "0" },
            { "label": { "en_GB": "Yes", "es_ES": "Sí" }, "value": "1" }
          ]
        }
      },
      {
        "code": "question3",
        "name": {
          "en_GB": "Have you ever had left and right buttock pain, at the same time or not?",
          "es_ES": "¿Ha tenido alguna vez dolor en el glúteo derecho o izquierdo, al mismo tiempo o por separado?"
        },
        "description": { "en_GB": "", "es_ES": "" },
        "input": {
          "type": "select",
          "options": [
            { "label": { "en_GB": "No", "es_ES": "No" }, "value": "0" },
            { "label": { "en_GB": "Yes", "es_ES": "Sí" }, "value": "1" }
          ]
        }
      },
      {
        "code": "question4",
        "name": {
          "en_GB": "Have you ever had a swollen and painful joint? (hands, feet, knees, or ankles, for example)",
          "es_ES": "¿Ha tenido alguna vez hinchazón y dolor en una articulación (manos, pies, rodillas o tobillos, por ejemplo)?"
        },
        "description": { "en_GB": "", "es_ES": "" },
        "input": {
          "type": "select",
          "options": [
            { "label": { "en_GB": "No", "es_ES": "No" }, "value": "0" },
            { "label": { "en_GB": "Yes", "es_ES": "Sí" }, "value": "1" }
          ]
        }
      }
    ]
  }
]

Cheatsheet de respuesta

Recuerda, si tu objetivo es usar esta información para consultar el endpoint severity-assessment, aquí están las claves en las que necesitas enfocarte y usar:

1. code

   • Qué es: El code representa el identificador corto para el sistema de puntuación.
   • Por qué es importante: Esta será la clave que necesitarás invocar dentro del cuerpo de tu solicitud bajo el objeto sistemas de puntuación.

2. path

   • Qué es: El path indica la URL del endpoint que debe ser invocado en los pasos siguientes.
   • Por qué es importante: Esto te guiará a la URL correcta para consultar la información de evaluación de la gravedad.

3. questionnaire y code para preguntas

   • Qué es: El questionnaire contiene un array de preguntas, cada una con un code único.
   • Por qué es importante: Cada code en el questionnaire es el identificador único de la pregunta. Estos son los valores que necesitas enviar en tu solicitud, ya que representan las respuestas a las preguntas específicas.

Tip

Usa esta cheatsheet como una referencia rápida para entender qué claves son importantes para hacer solicitudes correctas al endpoint diagnostic-assessment.

Detalles de la respuesta versión larga

Descripción de las claves más relevantes en el cuerpo de la respuesta:

• identifier

  • Descripción: Un identificador único para cada posible sistema de puntuación local o global. Se utiliza para ayudar al integrador a entender los resultados, pero no es necesario para ninguna solicitud de endpoint.
  • Ejemplo: "apasiLocal", "pure4"

• code

  • Descripción: Representa el identificador corto para el sistema de puntuación. Esta será la key que necesitarás invocar dentro del cuerpo de tu solicitud al endpoint severity-assessment bajo el objeto de sistemas de puntuación.
  • Ejemplo: "apasi", "pure4"

• mode

  • Descripción: Especifica si la evaluación es para uso local o global.
  • Valores: "local" (para áreas locales del cuerpo), "global" (para todo el cuerpo o múltiples regiones).
  • Ejemplo: "local", "global"

• path

  • Descripción: indica la URL del endpoint que debe ser invocado en los pasos siguientes.
  • Ejemplo: "/severity-assessment/image-based/local", "/severity-assessment/text-based"

• title

  • Descripción: El título de la herramienta de evaluación en diferentes idiomas. Esta clave contiene un objeto con códigos de idioma como claves y el título traducido como valores.
  • Ejemplo:

    {
      "en_GB": "Local automatic psoriasis area and severity index",
      "es_ES": "Índice automático de gravedad y área de psoriasis local"
    }

• description

  • Descripción: Una breve descripción de la herramienta en diferentes idiomas. Similar a title, contiene traducciones para diferentes idiomas.
  • Ejemplo:

    {
      "en_GB": "Clinical tool for a precise psoriasis severity assessment",
      "es_ES": "Herramienta clínica para determinar la gravedad de la psoriasis"
    }

• questionnaire

  • Descripción: Un array de preguntas incluidas en la herramienta de evaluación. Cada objeto de pregunta contiene varias claves para definir la pregunta y su tipo de entrada.
  • Ejemplo:

    [
      {
        "code": "surface",
        "name": {
          "en_GB": "Affected area",
          "es_ES": "Área afectada"
        },
        "description": {
          "en_GB": "This value corresponds to the percentage of involvement of the specific area of the body you are reporting",
          "es_ES": "Este valor corresponde al porcentaje de afectación de la zona concreta del cuerpo que estás reportando"
        },
        "input": {
          "type": "number",
          "min": 0,
          "max": 100
        }
      }
    ]

  Dentro de cada pregunta:

  • code: Un identificador único para la pregunta.
  • name: El texto de la pregunta en múltiples idiomas (códigos de idioma como claves).
  • description: Información o aclaración adicional sobre la pregunta (también en múltiples idiomas).
  • input: Define el tipo de entrada y las restricciones para la pregunta. Esto puede incluir:
    • type: El tipo de entrada (por ejemplo, "number", "select").
    • min/max: Los valores mínimo y máximo para la entrada numérica (si corresponde).
    • options: Un array de posibles opciones para una entrada select (por ejemplo, opciones Sí/No).

Observaciones

Nota

Este endpoint pertenece a la versión v2.0 de la API. Asegúrate de estar utilizando la versión correcta en tus solicitudes, ya que las versiones futuras pueden introducir cambios en la estructura o el comportamiento de este endpoint.