Patients

Get a Patient

Read one patient in the project.

get/patients/{patientId}

Request

  • Base URL: https://api.xcures.com/v3
  • URL: https://api.xcures.com/v3/patients/{patientId}
  • Auth: HTTP bearer

Path parameters

patientIdstring uuid required

The patient's id.

Headers

ProjectIdstring required

The project the patient belongs to.

Response

The patient.

idstring uuid required

The patient's id, which every other operation about the patient takes.

identifierstring required

patient-registry's six-character code for the patient.

firstNamestring required

The patient's first name.

middleNamestring nullable

The patient's middle name or initial; null when none was recorded.

lastNamestring required

The patient's last name.

birthDatestring date nullable

The patient's date of birth, as yyyy-mm-dd; null when none was recorded.

deathDatestring date nullable

The patient's date of death, as yyyy-mm-dd; null when none was recorded.

sexAtBirthstring nullable

The patient's sex at birth, as patient-registry holds it; null when none was recorded.

emailstring nullable

The patient's email address; null when none was recorded.

phoneNumberstring nullable

The patient's phone number; null when none was recorded.

labelsstring[]

The free-text tags the project's users put on the patient.

createdAtstring date-time required

When the patient's record was created.

updatedAtstring date-time required

When the patient's record was last updated.

Changes

No recorded changes to this operation across all 1 revision of this API.