Patients

Search Patients

Find the project's patients by who they are, a page at a time. Send the criteria in the body; a search naming none answers every patient your credential may see. Pages are ordered by last name, then first name, then id, and a page past the last answers no results.

post/patients/search

Request

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

Query parameters

pageNumberinteger

The page to answer, counting from 1.

pageSizeinteger

The most patients to answer on a page.

Headers

ProjectIdstring required

The project to search.

Request body

firstNamestring

The patient's first name.

lastNamestring

The patient's last name.

birthDatestring date

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

identifierstring

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

postalCodestring

The postal code of the patient's address.

patientIdsstring[]

Patient ids, each matched exactly; at least 1 and at most 100.

Response

One page of the patients the search matched.

pageNumberinteger required

The page this is, counting from 1.

pageSizeinteger required

The most patients a page holds.

totalCountinteger required

How many patients the search matched across every page.

Changes

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