Endpoint Parameters

To simplify the integration process for technical teams, we have developed a set of helper endpoints that streamline access to relevant data. These endpoints enable quick and efficient retrieval of information, facilitating seamless interaction between the diagnostic-support and severity-assessment endpoints. This minimizes the amount of additional code required from integrators.

Body Sites

This helper endpoint provides a standardized list of body site codes, which are used to specify the location of a pathology on the human body. These codes are essential for accurately defining the affected area when interacting with the diagnostic-support endpoint.

Endpoint URL:

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

Clinical Signs

This auxiliary endpoint offers a standardized list of clinical signs, including multilingual translations of the visual sign keys returned by the severity-measurement endpoint.

Endpoint URL:

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

Questionnaires

Each pathology or condition may be associated with one or more scoring systems. These scoring systems can either be calculated automatically through AI model analysis of the image or may require responses to specific questions from the patient or doctor. The severity-assessment endpoint, detailed in the Endpoint Specification section, triggers the calculation of these scoring systems.

This endpoint helps to:

• Identify if any scoring systems are associated with a particular pathology or condition, and provide details about them.
• Provide information about associated questionnaires, including the content of the questions and available answer options.

By providing the pathology query parameter with an ICD-11 code (e.g., EA90 for Psoriasis), users can obtain relevant scoring systems and questionnaires tailored to the pathology or condition.

Example Request

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

Required Parameters

The only required key is pathology. This is the ICD-11 code representing the specific pathology for which the questionnaire is needed. For example, EA90 represents Psoriasis.

The ICD-11 code is returned by the diagnostic-support endpoint. Refer to the Endpoint Specification section for details on retrieving pathology/condition codes.

Example Response

The API responds with a JSON object containing one or more questionnaires relevant to the specified pathology. These questionnaires are designed to gather standardized information that assists in the assessment and monitoring of the condition.

Relevant keys in the body of the response

[
  {
    "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 this cheatsheet to understand the keys required for querying the severity-assessment endpoint:

code

This is the short identifier for the scoring system. This is important because this key is used in the body of your request under the scoring systems object.

path

This is the endpoint URL for querying severity assessment information. This is important because it guides you to the correct URL for subsequent requests.

questionnaire and code

These are an array of questions, each with a unique code. This is important because these codes represent the answers to specific questions and are required in your request.

Tip

Use this cheatsheet as a quick reference for making accurate requests to the severity-assessment endpoint.

Response Details

Key Descriptions

identifier

A unique identifier for each scoring system. It helps integrators understand the results but is not required for endpoint requests.

For example, "apasiLocal" or "pure4".

code

The short identifier for the scoring system. This key is used in the body of your request to the severity-assessment endpoint.

For example, "apasi" or "pure4".

mode

Specifies whether the assessment is for local or global use.

• "local" (for specific body areas)
• "global" (for the whole body).

path

The endpoint URL for querying severity assessment information.

For example:

• "/severity-assessment/image-based/local"
• "/severity-assessment/text-based"

title

The title of the assessment tool in multiple languages.

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

description

A short description of the tool in multiple languages.

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

questionnaire

An array of questions included in the assessment tool. Each question object contains keys defining the question and its input type.

[
  {
    "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
    }
  }
]

Inside each question:

• code: A unique identifier for the question.
• name: The question text in multiple languages.
• description: Additional information about the question.
• input: Defines the input type and constraints (e.g., "number", "select").
  • type: The input type (e.g., "number", "select").
  • min/max: The minimum and maximum values for numeric input (if applicable).
  • options: An array of possible options for a select input (for example, Yes/No options).