Parâmetros de Endpoint
Para simplificar o processo de integração para equipes técnicas, desenvolvemos um conjunto de endpoints auxiliares que facilitam o acesso a dados relevantes. Esses endpoints permitem a recuperação rápida e eficiente de informações, promovendo uma interação perfeita entre os endpoints diagnostic-support e severity-assessment. Isso minimiza a quantidade de código adicional necessário para os integradores.
Locais do Corpo
Este endpoint auxiliar fornece uma lista padronizada de códigos de locais do corpo, que são usados para especificar a localização de uma patologia no corpo humano. Esses códigos são essenciais para definir com precisão a área afetada ao interagir com o endpoint diagnostic-support.
URL do Endpoint:
https://medical-device-params.legit.health/v2.0/body-sites
Sinais Clínicos
Este endpoint auxiliar oferece uma lista padronizada de sinais clínicos, incluindo traduções multilíngues das chaves de sinais visuais retornadas pelo endpoint severity-measurement.
URL do Endpoint:
https://medical-device-params.legit.health/v2.0/clinical-signs
Questionários
Cada patologia ou condição pode estar associada a um ou mais sistemas de pontuação. Esses sistemas de pontuação podem ser calculados automaticamente por meio da análise de imagem por modelos de IA ou podem exigir respostas a perguntas específicas do paciente ou médico. O endpoint severity-assessment, detalhado na seção Especificação de Endpoint, aciona o cálculo desses sistemas de pontuação.
Este endpoint ajuda a:
- Identificar se há sistemas de pontuação associados a uma determinada patologia ou condição, e fornecer detalhes sobre eles.
- Fornecer informações sobre os questionários associados, incluindo o conteúdo das perguntas e as opções de resposta disponíveis.
Ao fornecer o parâmetro de consulta pathology com um código ICD-11 (por exemplo, EA90 para Psoríase), os usuários podem obter sistemas de pontuação e questionários relevantes adaptados à patologia ou condição.
Exemplo de Requisição
https://medical-device-params.legit.health/v2.0/questionnaires?pathology=EA90
Parâmetros Necessários
A única chave necessária é pathology. Este é o código ICD-11 que representa a patologia específica para a qual o questionário é necessário. Por exemplo, EA90 representa Psoríase.
O código ICD-11 é retornado pelo endpoint diagnostic-support. Consulte a seção Especificação de Endpoint para obter detalhes sobre como recuperar códigos de patologia/condição.
Exemplo de Resposta
A API responde com um objeto JSON contendo um ou mais questionários relevantes para a patologia especificada. Esses questionários são projetados para coletar informações padronizadas que auxiliam na avaliação e monitoramento da condição.
[
{
"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
}
}
]
}
]
Cheatsheet
Use este cheatsheet para entender as chaves necessárias para consultar o endpoint severity-assessment:
code
Este é o identificador curto para o sistema de pontuação. Isso é importante porque essa chave é usada no corpo da sua requisição sob o objeto sistemas de pontuação.
path
Este é o URL do endpoint para consultar informações de avaliação de gravidade. Isso é importante porque orienta você para o URL correto para requisições subsequentes.
questionnaire e code
Estas são uma matriz de perguntas, cada uma com um code exclusivo. Isso é importante porque esses códigos representam as respostas a perguntas específicas e são necessários na sua requisição.
Use este cheatsheet como uma referência rápida para fazer requisições precisas ao endpoint severity-assessment.
Detalhes da Resposta
Descrições das Chaves
identifier
Um identificador exclusivo para cada sistema de pontuação. Ajuda os integradores a entender os resultados, mas não é necessário para as requisições ao endpoint.
Por exemplo, "apasiLocal" ou "pure4".
code
O identificador curto para o sistema de pontuação. Esta chave é usada no corpo da sua requisição ao endpoint severity-assessment.
Por exemplo, "apasi" ou "pure4".
mode
Especifica se a avaliação é para uso local ou global.
"local"(para áreas específicas do corpo)"global"(para o corpo todo).
path
O URL do endpoint para consultar informações de avaliação de gravidade.
Por exemplo:
"/severity-assessment/image-based/local""/severity-assessment/text-based"
title
O título da ferramenta de avaliação em múltiplas línguas.
{
"en_GB": "Local automatic psoriasis area and severity index",
"es_ES": "Índice automático de gravedad y área de psoriasis local"
}
description
Uma breve descrição da ferramenta em múltiplas línguas.
{
"en_GB": "Clinical tool for a precise psoriasis severity assessment",
"es_ES": "Herramienta clínica para determinar la gravedad de la psoriasis"
}
questionnaire
Uma matriz de perguntas incluídas na ferramenta de avaliação. Cada objeto de pergunta contém chaves que definem a pergunta e seu tipo de entrada.
[
{
"code": "surface",
"name": {
"en_GB": "Affected area",
"es_ES": "Área afetada"
},
"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 pergunta:
code: Um identificador exclusivo para a pergunta.name: O texto da pergunta em múltiplas línguas.description: Informações adicionais sobre a pergunta.input: Define o tipo de entrada e restrições (por exemplo,"number","select").type: O tipo de entrada (por exemplo,"number","select").min/max: Os valores mínimo e máximo para entrada numérica (se aplicável).options: Uma matriz de opções possíveis para uma entrada de seleção (por exemplo, opções Sim/Não).