Skip to main content

Data Export - Patients

Patient​

Generated by the Bulk Data Export system

The order of columns is subject to change. When parsing files, please ensure to use headers rather than positional parsing to ensure you are reading the data correctly.

What this export contains​

One row per patient, the people receiving treatment at your institute, with their demographics and contact details. There is a single row per patient no matter how many episodes of care or assessments they have. Treat this as the master list that most other clinical exports link back to by patient id.

Example questions this export can answer​

  • Build a current roster of patients with contact details for outreach
  • Report on the demographic mix (age, gender, race, ethnicity, language) of the population you serve
  • Attach patient names and demographics to visits, assessments or outcomes by joining on patient id
  • Find patients missing key fields like email, phone or MRN
PropertyNameField TypeCardinalityNotes
instituteidInstitute Ididentifier1..*
instituteShortcodeInstitute ShortcodeString1..*
idIdidentifier1..1
identifierExternal Identifiersidentifier0..*
mrnMRNstring0..1
genderGenderstring0..1
birthDateDate of Birthdate0..1
givenNameGiven Namestring0..1
familyNameFamily Namestring0..1
primaryProviderIdPrimary Provider Ididentifier0..1Practitioner
isTestIs Test?boolean1..1
primaryLanguagePrimary Languagestring0..1
raceRacestring0..1
ethnicityEthnicitystring0..1
maritalStatusMarital Statusstring0..1
veteranStatusVeteran Statusstring0..1
phoneNumberPhone Numberstring0..1Patient’s phone number in E. 164 format.
emailEmailstring0..1
stateStatestring0..1In 2-letter abbreviation, e.g. MA
zipCodeZipcodestring0..1
timezoneTimezonestring0..1In IANA Time Zone Database format, e.g. America/New_York
sourceSourceenum0..1How the patient record originated: manual | bulk_importalgorithmunknown