Patient
Patient
Source Object: Patient
The Patient source object represents a fundamental entity in healthcare systems, embodying the individuals receiving medical care and treatment. Patient data is of paramount importance, serving as the foundation for electronic health records (EHR) and clinical management.
Overview
Patients are at the core of healthcare operations. The Patient source object encompasses a wide array of information related to an individual's health, personal details, preferences, and legal considerations. These include but are not limited to name, address, contact information, demographics, and more.
Usage
The Patient source object is utilized in various ways:
- Demographic Information: It stores key demographic details such as first name, last name, date of birth (DOB), gender identity, legal gender marker, ethnicity, race, sexual orientation, and preferred language.
- Contact Information: Patient addresses, emails, and phone numbers are maintained to ensure healthcare providers can communicate and reach out to the patient or their designated emergency contact if needed.
- Guarantor Information: For billing and administrative purposes, guarantor details are recorded, including their name, address, phone, and relationship to the patient.
- Healthcare Provider: It may include the primary care provider's name and National Provider Identifier (NPI), facilitating care coordination and management.
- Legal and Identity: Patient Social Security Number (SSN) and information related to name changes (previous first and last names) are recorded.
- Preferences and VIP Status: Patients' preferences regarding pharmacies and VIP status (if applicable) are stored for tailored healthcare services.
- Consents: Consent-related data, such as the application for consent and the date of consent, are captured to ensure compliance with healthcare regulations.
- Employer Details: Information about the patient's employer, including code, description, and name, may be included for occupational health considerations.
- Patient Merge: The data model includes information about patients merged into the current patient chart.
- Pronouns: The source object records the pronouns preferred by the patient, respecting their gender identity.
Patients are the central focus of healthcare systems, and the Patient source object plays a vital role in ensuring that patient data is accurately and comprehensively recorded for healthcare providers to deliver quality care.
Mapping Table
| Data Field | Source Field Data Type | Resource Mapping Context | Source Data Field Cardinality | Source Data Field Description | Example Value | Source Data Field Validation Rule | Mapped FHIR Resource | Mapped FHIR Data Field | Augmented Mapping | Associated Coding System | Associated FHIR Data Field Extension | Mapped FHIR Data Field Type |
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| actual_name | String | Top Level | 0..1 | optional for POST or PUT | Paul Patient | string(150) | Patient | name[*}.text | name[].use = usual | NA | - | string |
| address | Object | Top Level | 0..1 | - | - | - | Patient | - | - | NA | - | na |
| address.address_line1 | String | Top Level | 1..1 | - | 550 15th Street | string(200) | Patient | address[1].line[1] | - | NA | - | string |
| address.address_line2 | String | Top Level | 0..1 | - | 21 | string(35) | Patient | address[1].line[2] | - | NA | - | string |
| address.city | String | Top Level | 0..1 | - | San Francisco | string(50) | Patient | address[1].city | - | NA | - | string |
| address.state | String | Top Level | 0..1 | - | CA | string(2) | Patient | address[1].state | - | NA | - | string |
| address.zip | String | Top Level | 0..1 | - | 94103 | integer(9 digits) | Patient | address[1].postalcode | - | NA | - | string |
| caregiver_practice | Id | Top Level | 1..1 | read-only. required for POST and PUT | 65540 | - | Patient | extension[*].valueInteger | - | NA | practice | integer |
| created_date | DateTime | Top Level | 0..1 | read-only | 2016-05-02T11:57:41Z | datetime(iso8601) | Patient | extension[*].valueString | - | NA | created-date | string |
| deleted_date | DateTime | Top Level | 0..1 | read-only | null | datetime(iso8601) | Patient | extension[*].valueString | - | NA | deleted-date | string |
| dob | Date | Top Level | 1..1 | required for POST and PUT | 1940-08-29 | date(YYYY-MM-DD) | Patient | birthDate | - | NA | - | date |
| emails | Object | Top Level | 0..* | - | - | only 1 email with empty deleted_date | Patient | - | system = email | NA | - | na |
| emails.created_date | DateTime | Top Level | 0..1 | read-only | 2016-10-10T23:31:49 | datetime(iso8601) | Patient | telecom[*].period.start | system = email | NA | - | dateTime |
| emails.deleted_date | DateTime | Top Level | 0..1 | read-only | null | datetime(iso8601) | Patient | telecom[*].period.end | system = email | NA | - | dateTime |
| emails.email | String | Top Level | 1..1 | - | paul.patient@elationemr.com | string(75) | Patient | telecom[*].value | system = email | NA | - | string |
| emergency_contact | Object | Top Level | 0..1 | - | - | - | Patient | - | - | NA | - | na |
| emergency_contact.address_line1 | String | Top Level | 0..1 | - | 19 test ave | string(200) | Patient | contact[1].address.line[1] | - | NA | - | string |
| emergency_contact.address_line2 | String | Top Level | 0..1 | - | #12 | string(35) | Patient | contact[1].address.line[2] | - | NA | - | string |
| emergency_contact.city | String | Top Level | 0..1 | - | San Francisco | string(50) | Patient | contact[1].address.city | - | NA | - | string |
| emergency_contact.first_name | String | Top Level | 0..1 | - | John | string(70) | Patient | contact[1].name.given[1] | - | NA | - | string |
| emergency_contact.last_name | String | Top Level | 0..1 | - | Doe | string(70) | Patient | contact[1].name.family | - | NA | - | string |
| emergency_contact.phone | String | Top Level | 0..1 | - | 4151231234 | string(20) | Patient | contact[1].telecom[*].value | system = phone | NA | - | string |
| emergency_contact.relationship | ValueSet | Top Level | 0..1 | - | Child | "Caregiver", "Child", "Friend", "Grandparent", "Guardian", "Parent", "Sibling", "Spouse", "Other" | Patient | contact[1].relationship[*].text | coding[].code = C | NA | - | string |
| emergency_contact.state | String | Top Level | 0..1 | - | CA | string(2) | Patient | contact[1].address.state | - | NA | - | string |
| emergency_contact.zip | String | Top Level | 0..1 | - | 123456789 | string(10) | Patient | contact[1].address.postalcode | - | NA | - | string |
| ethnicity | ValueSet | Top Level | 0..1 | - | Not Hispanic or Latino | "No ethnicity specified", "Hispanic or Latino", "Not Hispanic or Latino", "Declined to specify" | Patient | extension[*].valueString | - | NA | us-core-ethnicity | string |
| first_name | String | Top Level | 1..1 | required for POST and PUT | Paula | string(70) | Patient | name[*].given[1] | name[].use = official | NA | - | string |
| gender_identity | ValueSet | Top Level | 0..1 | optional for POST or PUT | woman | "unknown", "man", "woman", "transgender_man", "transgender_woman", "nonbinary", "option_not_listed", "prefer_not_to_say", "two_spirit" | Patient | gender | - | NA | - | code |
| id | Long | Top Level | 0..1 | read-only | 64184451073 | long(64) | Patient | id | - | NA | - | string |
| last_name | String | Top Level | 1..1 | required for POST and PUT | Patient | string(70) | Patient | name[*].family | name[].use = official | NA | - | string |
| legal_gender_marker | ValueSet | Top Level | 0..1 | optional for POST or PUT | F | "M", "F", "X", "U" | Patient | extension[*].valueString | - | NA | gender-marker | string |
| master_patient | Boolean | Top Level | 0..1 | - | null | - | Patient | extension[*].valueString | - | NA | master-patient | string |
| merged_into_chart | Long | Top Level | 0..1 | read-only | null | long(64) | Patient | extension[*].valueInteger | - | NA | merged | integer |
| metadata | String | Top Level | 0..1 | - | null | - | Patient | meta | - | NA | - | TBD |
| middle_name | String | Top Level | 0..1 | - | P | string(50) | Patient | name[*].given[2] | name[].use = official | NA | - | string |
| notes | String | Top Level | 0..1 | - | This is test Notes | string(500) | Patient | extension[*].valueString | - | NA | notes | string |
| phones | Object | Top Level | 0..* | - | - | max 2 phones | Patient | - | system = phone | NA | - | na |
| phones.created_date | DateTime | Top Level | 0..1 | read-only | 2016-10-10T23:31:49 | datetime(iso8601) | Patient | telecom[*].period.start | system = phone | NA | - | dateTime |
| phones.deleted_date | DateTime | Top Level | 0..1 | read-only | null | datetime(iso8601) | Patient | telecom[*].period.end | system = phone | NA | - | dateTime |
| phones.phone | String | Top Level | 1..1 | - | 4155555555 | string(20) | Patient | telecom[*].value | system = phone | NA | - | string |
| phones.phone_type | ValueSet | Top Level | 1..1 | - | Home | "Mobile", "Home", "Main", "Work", "Night", "Fax", "Other" | Patient | telecom[*].use | system = phone | NA | - | code |
| preference | Object | Top Level | 0..1 | - | - | - | Patient | - | - | NA | - | na |
| preference.preferred_pharmacy_1 | Id | Top Level | 0..1 | - | null | ncpdpid | Patient | extension[*].extension[1].valueString | - | NA | preferred-pharmacy | string |
| preference.preferred_pharmacy_2 | Id | Top Level | 0..1 | - | null | ncpdid | Patient | extension[*].extension[2].valueString | - | NA | preferred-pharmacy | string |
| preferred_language | ValueSet | Top Level | 0..1 | - | English | - | Patient | communication[*].language.text | communication[].preferred = true | NA | language | string |
| previous_first_name | String | Top Level | 0..1 | optional, can be specified | null | string(70) | Patient | name[*].given[1] | name[].use = old | NA | - | string |
| previous_last_name | String | Top Level | 0..1 | optional, can be specified | null | string(70) | Patient | name[*].family | name[].use = old | NA | - | string |
| primary_care_provider | Id | Top Level | 0..1 | primary_care_provider is a read-only field that provides the internal Elation id of the collaborator record that is created within your practice to represent your practice's connection with the patient's primary care provider. | 131074 | - | Patient | extension[*].valueString | - | NA | provider | string |
| primary_care_provider_npi | String | Top Level | 0..1 | primary_care_provider_npi represents the patient's primary care provider. This person may be in a different practice. This field is not required. | 1234567893 | string(10) | Patient | extension[*].valueString | - | NA | provider-npi.html | string |
| primary_physician | Id | Top Level | 1..1 | primary_physician represents the physician providing care to the patient within your practice. This is a required field. This value must match the id of one of the physicians retrieved via the Find Physicians endpoint. | 131074 | - | Patient | generalPractitioner[*].reference | - | NA | - | reference |
| pronouns | ValueSet | Top Level | 0..1 | optional for POST and PUT | he_him_his | "he_him_his", "she_her_hers", "they_them_theirs", "not_listed" | Patient | extension[*].valueString | - | NA | pronouns | string |
| race | ValueSet | Top Level | 0..1 | - | Asian | "No race specified", "American Indian or Alaska Native", "Asian", "Black or African American", "Native Hawaiian or Other Pacific Islander", "White", "Declined to specify" | Patient | extension[*].valueString | - | NA | us-core-race | string |
| sex | ValueSet | Top Level | 1..1 | required for POST and PUT | Female | "Male", "Female", "Other", "Unknown" | Patient | extension[*].valueCode | - | NA | us-core-birthsex | code |
| sexual_orientation | ValueSet | Top Level | 0..1 | optional for POST or PUT | queer | "unknown", "straight", "gay", "bisexual", "option_not_listed", "prefer_not_to_say", "lesbian", "queer", "asexual" | Patient | extension[*].valueString | - | NA | sexual-orientation | string |
| ssn | Integer | Top Level | 0..1 | - | 123456789 | integer(9 digits) | Patient | identifier[*].value | system = "http://hl7.org/fhir/sid/us-ssn" | NA | - | string |
| tags | String | Top Level | 0..* | - | PAID | max 10 tags | Patient | extension[].extension[].valueString | - | NA | tags | string |
| vip | Boolean | Top Level | 0..1 | feature must be enabled for practice | FALSE | - | Patient | extension[*].valueBoolean | - | NA | vip | boolean |
| employer | Object | Contained | 0..1 | employer field is enterprise use only | - | - | RelatedPerson | - | - | NA | - | na |
| employer.code | String | Contained | 0..1 | - | EMP_1 | - | RelatedPerson | contained[].identifier[].value | - | NA | - | string |
| employer.description | String | Contained | 0..1 | - | Employer Description 1 | - | RelatedPerson | container[*].text.div | - | NA | - | xhtml |
| employer.name | String | Contained | 0..1 | - | Employer Name 1 | - | RelatedPerson | contained[*].name[1].text | - | NA | - | string |
| guarantor | Object | Contained | 0..1 | - | - | - | RelatedPerson | - | - | NA | - | na |
| guarantor.address | String | Contained | 0..1 | - | 101 Lane Street | - | RelatedPerson | contained[*].address[1].line | - | NA | - | string |
| guarantor.city | String | Contained | 0..1 | - | Madison | - | RelatedPerson | contained[*].address[1].state | - | NA | - | string |
| guarantor.first_name | String | Contained | 0..1 | - | Other | - | RelatedPerson | contained[*].name[1].given[1] | use == "official" | NA | - | string |
| guarantor.id | Id | Contained | 0..1 | - | 123456789 | - | RelatedPerson | contained[*].id | - | NA | - | integer |
| guarantor.last_name | String | Contained | 0..1 | - | Test | - | RelatedPerson | contained[*].name[1].family | use == "official" | NA | - | string |
| guarantor.middle_name | String | Contained | 0..1 | - | null | - | RelatedPerson | contained[*].name[1].given[2] | use == "official" | NA | - | string |
| guarantor.phone | Integer | Contained | 0..1 | - | 1231231233 | - | RelatedPerson | contained[*].telecom[1].value | - | NA | - | string |
| guarantor.relationship | ValueSet | Contained | 0..1 | - | Other | "Spouse", "Child", "Other" | RelatedPerson | contained[*].relationship[1].text | coding[1].code == "O" | NA | - | string |
| guarantor.state | String | Contained | 0..1 | - | WI | - | RelatedPerson | contained[*].address[1].state | - | NA | - | string |
| guarantor.zip | String | Contained | 0..1 | - | 53711 | - | RelatedPerson | contained[*].address[1].postalcode | - | NA | - | string |
| consents | Object | Contained | 0..* | read-only | - | no max | Consent | - | - | NA | - | na |
| consents.application | String | Contained | 0..1 | - | healthix | string(255) | Consent | container[*].text.div | - | NA | - | xhtml |
| consents.consented | Boolean | Contained | 0..1 | - | TRUE | - | Consent | contained[].extension[].valueBoolean | - | NA | - | boolean |
| consents.last_modified_date | DateTime | Contained | 0..1 | - | 2016-05-02T11:57:41Z | datetime(iso8601) | Consent | contained[*].dateTime | - | NA | - | dateTime |