getPatientDemographics

Returns the demographic information HealthEx has on file for a patient in the context of a project: name, date of birth, gender, contact details, mailing address, and the project-scoped externalId. Patient tokens may only fetch their own record; organization users and API clients must own the project and have an active patient-data-sharing consent from the patient on it.

Path Parameters
projectId string — REQUIRED HealthEx project (study) id
patientId string — REQUIRED HealthEx patient id

Responses

200 Patient demographics Schema — OPTIONAL patientId string HealthEx patient id. firstName object — OPTIONAL Patient's first name. lastName object — OPTIONAL Patient's last name. dateOfBirth object — OPTIONAL Date of birth in ISO 8601 (YYYY-MM-DD) format. gender object — OPTIONAL Patient's gender. Typical values: male, female, other, unknown. email object — OPTIONAL Patient's current primary email address. phone object — OPTIONAL Patient's current primary phone number in E.164 format. externalId object — OPTIONAL Identifier your organization assigned this patient in this project. addressLines string[] — OPTIONAL Ordered list of street address lines (street, unit, building, c/o). Empty when no address is on file. city object — OPTIONAL City or locality. district object — OPTIONAL Second-level administrative division (e.g. county in the US). state object — OPTIONAL First-level administrative division (US state, region, province, etc.). postalCode object — OPTIONAL ZIP or postal code. country object — OPTIONAL ISO country code.