The symptoms endpoint is used in conjunction with the chat endpoint to provide a programmatical method by which partial symptoms entered by the user can be searched and known symptoms returned so that they can be chosen and used for autocomplete type questions (see Question and Answer types for more details)

GET https://portal.your.md/api/v1/symptom-search

Parameters

Parameter name	Description
text	Partial symptom entered by the user
gender	`male` or `female` - not required

Example request

curl --location 'https://portal.your.md/api/v1/symptom-search?text=itch' \
--header 'Content-Type: application/json' \
--header 'Accept: */*' \
--header 'Authorization: Bearer abc' \
--header 'x-api-key: GrNh3vPVdckgA9mCHxdmaSM2ucaywMZ9HbRJ1qTa'

Example response

{
    "user_facing_prefix": "also known as",
    "autocomplete": [
        {
            "id": "assessment_C0033774",
            "cui": "C0033774",
            "user_facing_name": "Itchy sensation/itchiness",
            "medical_name": "itchy skin",
            "highlight": "<i>itchy</i> skin"
        },
        {
            "id": "assessment_CM000288",
            "cui": "CM000288",
            "user_facing_name": "Itchy skin mole",
            "medical_name": "itchy mole",
            "highlight": "<i>itchy</i> mole"
        },
        {
            "id": "clarify_C0700184",
            "cui": "C0700184",
            "user_facing_name": "Itchy or scratchy throat",
            "highlight": "<i>itchy</i> or scratchy throat"
        },
        {
            "id": "assessment_C1168272",
            "cui": "C1168272",
            "user_facing_name": "Switching between constipation and diarrhoea",
            "highlight": "<i>switching</i> between constipation and diarrhoea"
        },
        {
            "id": "assessment_C0033774",
            "cui": "C0033774",
            "user_facing_name": "Itchy sensation/itchiness",
            "highlight": "<i>itchy</i> sensation/<i>itchiness</i>"
        },
        {
            "id": "assessment_C0033771",
            "cui": "C0033771",
            "user_facing_name": "Itchy rash",
            "highlight": "<i>itchy</i> rash"
        },
        {
            "id": "assessment_C0240941",
            "cui": "C0240941",
            "user_facing_name": "Itchy scalp",
            "highlight": "<i>itchy</i> scalp"
        },
        {
            "id": "assessment_C0033777",
            "cui": "C0033777",
            "user_facing_name": "Itchy genital region",
            "highlight": "<i>itchy</i> genital region"
        },
        {
            "id": "assessment_C0423578",
            "cui": "C0423578",
            "user_facing_name": "Itchy eye(s)",
            "medical_name": "eye itchy",
            "highlight": "eye <i>itchy</i>"
        }
    ]
}