Get the details of an individual patient

GET /patients/{patientId}

Path parameters

  • patientId string(uuid) Required

    The ID of the patient to retrieve

Responses

  • 200

    OK

    Hide response attributes Show response attributes 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.
GET /patients/{patientId} 
curl \
 -X GET https://example.com/api/patients/{patientId} \
 -H "Authorization: Bearer $ACCESS_TOKEN"
Response examples (200) 
{
  "_id": "b5ac2f19-56c3-4db9-9d6d-76a821cff842",
  "name": "John Doe",
  "gender": "MALE",
  "patientCategory": "GENERAL",
  "phoneNumber": "01234567890",
  "residentialAddress": "Guesthouse"
}
Response examples (200) 
{
  "_id": "string",
  "patientNumber": "23-72362",
  "age": 23,
  "name": "John Doe",
  "gender": "MALE",
  "patientCategory": "GENERAL",
  "phoneNumber": "+1234567890",
  "residentialAddress": "Guesthouse"
}