---
updatedAt: 2026-07-13T13:58:38.000Z
agentTools:
  projectIndex: https://developer.livehealthily.com/llms.txt
---

# Symptom search

Symptom search Backed by a search engine, allows partial matches and returns symptom IDs.

# OpenAPI definition

```json
{
  "openapi": "3.0.1",
  "info": {
    "title": "Healthily API documentation",
    "version": "1.0.0-RC1"
  },
  "servers": [
    {
      "url": "https://portal.your.md",
      "description": "Production server url"
    },
    {
      "url": "http://localhost:8080",
      "description": "Local testing url"
    }
  ],
  "tags": [
    {
      "name": "Consultation",
      "description": "The Consultation API"
    }
  ],
  "paths": {
    "/api/v1/symptom-search": {
      "get": {
        "tags": [
          "Consultation"
        ],
        "summary": "Symptom search",
        "description": "Symptom search Backed by a search engine, allows partial matches and returns symptom IDs.",
        "operationId": "searchTerm",
        "parameters": [
          {
            "name": "authorization",
            "in": "header",
            "required": true,
            "schema": {
              "type": "string"
            },
            "example": "Bearer your-token"
          },
          {
            "name": "x-api-key",
            "in": "header",
            "required": true,
            "schema": {
              "type": "string"
            },
            "example": "your-api-key"
          },
          {
            "name": "text",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            },
            "example": "head"
          },
          {
            "name": "gender",
            "in": "query",
            "schema": {
              "$ref": "#/components/schemas/Gender"
            },
            "example": "male"
          }
        ],
        "responses": {
          "200": {
            "description": "Successfully returned matching symptoms",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/SearchResponse"
                }
              }
            }
          },
          "400": {
            "description": "Bad request - missing or invalid search text",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "500": {
            "description": "Server error",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          }
        },
        "security": [
          {
            "BearerAuth": []
          }
        ]
      }
    }
  },
  "components": {
    "schemas": {
      "AutocompleteSymptom": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "description": "Internal ID of symptom",
            "example": "assessment_C0231749"
          },
          "cui": {
            "type": "string",
            "description": "Internal ID of symptom",
            "example": "C0231749"
          },
          "dropdown_name": {
            "type": "string",
            "description": "User friendly name for symptom with synonym if available, to be used in the dropdown for search",
            "example": "Jaw clicking (Clicking noises from jaw)"
          },
          "display_name": {
            "type": "string",
            "description": "User friendly name for symptom to display after it has been selected",
            "example": "Jaw clicking"
          },
          "highlight": {
            "type": "string",
            "description": "Name with highlighted search term",
            "example": "Jaw **clicking** (Clicking noises from jaw)"
          }
        },
        "description": "Autocomplete symptom information"
      },
      "ErrorResponse": {
        "required": [
          "error",
          "message"
        ],
        "type": "object",
        "properties": {
          "error": {
            "type": "string"
          },
          "message": {
            "type": "string"
          }
        },
        "description": "Basic error response"
      },
      "Gender": {
        "type": "string",
        "enum": [
          "male",
          "female"
        ]
      },
      "SearchResponse": {
        "type": "object",
        "properties": {
          "user_facing_prefix": {
            "type": "string",
            "description": "Display name prefix",
            "example": "also known as"
          },
          "autocomplete": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/AutocompleteSymptom"
            }
          }
        },
        "description": "Search response"
      }
    },
    "securitySchemes": {
      "BearerAuth": {
        "type": "http",
        "scheme": "bearer"
      }
    }
  }
}
```