Patients

Create a Patient

Add a patient to the project under an id you choose. Creating the same id again, or the same person under another id, answers 409, so a create is safe to repeat after a timeout. Creating a patient starts no records query; create one with createQuery when you want the patient's records.

post/patients

Request

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

Headers

ProjectIdstring required

The project to add the patient to.

Request body

idstring uuid required

The id to create the patient under, which you choose.

firstNamestring required

The patient's first name.

middleNamestring

The patient's middle name or initial.

lastNamestring required

The patient's last name.

birthDatestring date

The patient's date of birth, as yyyy-mm-dd.

deathDatestring date

The patient's date of death, as yyyy-mm-dd.

sexAtBirthstring

The patient's sex at birth, as patient-registry holds it.

emailstring

The patient's email address.

phoneNumberstring

The patient's phone number.

labelsstring[]

Free-text tags to put on the patient.

Response

The patient, as created.

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.