Search for patients

GET /patients/search

Query parameters

  • q string Required

    The query that specifies which patients are searched for.

Responses

  • 200

    OK

    Hide response attributes Show response attributes object
    • embedded object
      Hide embedded attribute Show embedded attribute object
      • patientResourceList array[object]
        Hide patientResourceList attributes Show patientResourceList attributes array[object]
        • _id string(uuid) Required

          Technical identifier of the patient

        • patientNumber string | null

          The identifier used by the hospital staff to correlate patients with their data.

          Minimum length is 1.

        • age integer | null

          The number of years that have passed since the patient's date of birth.

          Minimum value is 0.

        • name string | null

          All the name parts, i.e. first name, middle name, and last name.

          Minimum length is 1.

        • gender string | null

          Values are MALE, FEMALE, or OTHER.

        • patientCategory string | null

          Values are GENERAL, INPATIENT, or OUTPATIENT.

        • phoneNumber string | null

          Patient phone number

          Minimum length is 1.

        • residentialAddress string | null

          Patient residential address

          Minimum length is 1.

    • page object
      Hide page attributes Show page attributes object
GET /patients/search 
curl \
 -X GET https://example.com/api/patients/search?q=John+Doe \
 -H "Authorization: Bearer $ACCESS_TOKEN"
Response examples (200) 
{
  "embedded": {
    "patientResourceList": [
      {
        "_id": "string",
        "patientNumber": "23-72362",
        "age": 23,
        "name": "John Doe",
        "gender": "MALE",
        "patientCategory": "GENERAL",
        "phoneNumber": "+1234567890",
        "residentialAddress": "Guesthouse"
      }
    ]
  },
  "page": {
    "size": 20,
    "totalElements": 1,
    "totalPages": 1,
    "number": 0
  }
}
Response examples (200) 
{
  "embedded": {
    "patientResourceList": [
      {
        "_id": "string",
        "patientNumber": "23-72362",
        "age": 23,
        "name": "John Doe",
        "gender": "MALE",
        "patientCategory": "GENERAL",
        "phoneNumber": "+1234567890",
        "residentialAddress": "Guesthouse"
      }
    ]
  },
  "page": {
    "size": 20,
    "totalElements": 1,
    "totalPages": 1,
    "number": 0
  }
}