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
| Property | Name | Field Type | Cardinality | Notes | ||
|---|---|---|---|---|---|---|
| instituteid | Institute Id | identifier | 1..* | |||
| instituteShortcode | Institute Shortcode | String | 1..* | |||
| id | Id | identifier | 1..1 | |||
| identifier | External Identifiers | identifier | 0..* | |||
| mrn | MRN | string | 0..1 | |||
| gender | Gender | string | 0..1 | |||
| birthDate | Date of Birth | date | 0..1 | |||
| givenName | Given Name | string | 0..1 | |||
| familyName | Family Name | string | 0..1 | |||
| primaryProviderId | Primary Provider Id | identifier | 0..1 | Practitioner | ||
| isTest | Is Test? | boolean | 1..1 | |||
| primaryLanguage | Primary Language | string | 0..1 | |||
| race | Race | string | 0..1 | |||
| ethnicity | Ethnicity | string | 0..1 | |||
| maritalStatus | Marital Status | string | 0..1 | |||
| veteranStatus | Veteran Status | string | 0..1 | |||
| phoneNumber | Phone Number | string | 0..1 | Patient’s phone number in E. 164 format. | ||
| string | 0..1 | |||||
| state | State | string | 0..1 | In 2-letter abbreviation, e.g. MA | ||
| zipCode | Zipcode | string | 0..1 | |||
| timezone | Timezone | string | 0..1 | In IANA Time Zone Database format, e.g. America/New_York | ||
| source | Source | enum | 0..1 | How the patient record originated: manual | bulk_import | algorithm | unknown |