Patient
Source Object: Patient
Overview and Usage: The "Patient" source object is a fundamental component in healthcare systems, containing essential information about individual patients. It serves as the core record for patients and encompasses a wide range of personal, clinical, and demographic data. Here's a brief description of some key fields included in this source object:
- Address1, Address2, City, State, Zip: These fields store the patient's address details, helping in geolocation and contact information.
- Consent: Records consent-related details, including consent to receive various types of communication and information.
- DOB (Date of Birth): Captures the patient's birthdate for age calculation and age-related healthcare decisions.
- Email, Home Phone, Mobile Phone, Work Phone: These fields store contact information, enabling healthcare providers to communicate with patients efficiently.
- Ethnicity, Race: Provide information about the patient's ethnicity and racial background, which is important for clinical care and reporting.
- Sex: Specifies the patient's biological sex, a vital clinical consideration.
- Employer: Contains information about the patient's employer, which may be relevant for insurance and occupational health records.
- Deceased Date: Records the date of a patient's death if applicable.
- Driver's License: Includes the driver's license number, expiration date, and state of issuance.
- Guarantor: If someone other than the patient is financially responsible, this section includes details about the guarantor, such as their name, address, and relationship to the patient.
- Guardian: Specifies the details of a legal guardian, if applicable, including their name and relationship to the patient.
- Mobile Carrier: If applicable, this field records the patient's mobile carrier for text message communications.
- Language: Captures the patient's preferred language for healthcare communication.
- Marital Status: Records the patient's marital status, which may have implications for medical decision-making and billing.
- Next of Kin: Contains information about a patient's next of kin, including their name, phone number, and relationship to the patient.
- Occupation: Provides details about the patient's occupation, which can be relevant for understanding occupational health risks.
- Veteran: Specifies whether the patient is a veteran.
- Last Modified (Chart Alert): Records information related to the last modification of chart alerts, including the timestamp, modifying user, and note text.
- Country Code: Stores the country code for the patient's location.
The "Patient" source object is foundational for healthcare systems, enabling comprehensive and accurate patient management. It is a repository for a diverse set of patient details, crucial for clinical care, billing, and patient communication. Accurate and up-to-date patient information is vital for providing quality healthcare services.
Mapping Table
| Data Field | Example Value | Source Data Field Description | Source Field Data Type | Source Data Field Cardinality | Mapped FHIR++ Resource | Mapped FHIR Data Field | Augmented Mapping | Associated Coding System | Associated FHIR Data Field Extension | Mapping Context |
|---|---|---|---|---|---|---|---|---|---|---|
| address1 | - | Patient's address - 1st line (Max length: 100) | String | 0..1 | Patient | address[1].line[1] | - | - | - | Top Level |
| address2 | - | Patient's address - 2nd line (Max length: 100) | String | 0..1 | Patient | address[1].line[2] | - | - | - | Top Level |
| city | - | Patient's city (Max length: 30) | String | 0..1 | Patient | address[1].city | - | - | - | Top Level |
| consenttotext | - | The flag is used to record the consent of a patient to receive text messages per FCC requirements. In order for this to be true, a valid mobile phone number must be set and the practice setting 'Hide SMS Opt-in option' must be set to Off. | Boolean | 0..1 | Consent | extension[*].valueBoolean | - | - | consent-to-text | Contained |
| departmentid | - | Primary (registration) department ID. | Integer | 1..1 | Patient | extension[*].valueInteger | - | - | department-id | Top Level |
| dob | - | Patient's DOB (mm/dd/yyyy) | String | 1..1 | Patient | birthDate | - | - | - | Top Level |
| - | Patient's email address. 'declined' can be used to indicate just that. | String | 0..1 | Patient | telecom[*].value | system=email | - | - | Top Level | |
| ethnicitycode | - | Ethnicity of the patient, using the 2.16.840.1.113883.5.50 codeset. See http://www.hl7.org/implement/standards/fhir/terminologies-v3.html Special case: use 'declined' to indicate that the patient declined to answer. | String | 0..1 | Patient | extension[*].extension[1].valueString | - | - | ethnicity-codes | Top Level |
| firstname | - | Patient's first name (Max length: 20) | String | 1..1 | Patient | name[*].given[1] | use=official | - | - | Top Level |
| homephone | - | The patient's home phone number. Invalid numbers in a GET will be ignored. Patient phone numbers and other data may change, and one phone number may be associated with multiple patients. You are responsible for taking additional steps to verify patient identity and for using this data in accordance with applicable law, including HIPAA. Only phone numbers that exist in the North American Naming Plan (NANP) are acceptable for input. | String | 0..1 | Patient | telecom[*].value | system=phone,use=home | - | - | Top Level |
| lastname | - | Patient's last name (Max length: 20) | String | 1..1 | Patient | name[*].family | use=official | - | - | Top Level |
| middlename | - | Patient's middle name (Max length: 20) | String | 0..1 | Patient | name[*].given[2] | use=official | - | - | Top Level |
| mobilephone | - | The patient's mobile phone number. On input, 'declined' can be used to indicate no number. (Alternatively, hasmobile can also be set to false. 'declined' simply does this for you.) Invalid numbers in a GET will be ignored. Patient phone numbers and other data may change, and one phone number may be associated with multiple patients. You are responsible for taking additional steps to verify patient identity and for using this data in accordance with applicable law, including HIPAA. Only phone numbers that exist in the North American Naming Plan (NANP) are acceptable for input. | String | 0..1 | Patient | telecom[*].value | system=phone,use=mobile | - | - | Top Level |
| primaryproviderid | - | The 'primary' provider for this patient, if set. | String | 0..1 | Patient | generalPractitioner[*].reference | - | - | - | Top Level |
| race | - | The patient race, using the 2.16.840.1.113883.5.104 codeset. See http://www.hl7.org/implement/standards/fhir/terminologies-v3.html Special case: use 'declined' to indicate that the patient declined to answer. Multiple values or a tab-seperated list of codes is acceptable for multiple races for input. The first race will be considered 'primary'. Note: you must update all values at once if you update any. | String | 0..1 | Patient | extension[*].extension[1].valueString | - | - | http://hl7.org/fhir/us/core/StructureDefinition/us-core-race | Top Level |
| sex | - | Patient's sex (M/F) | String | 0..1 | Patient | extension[*].valueCode | - | - | legal-sex | Top Level |
| workphone | - | The patient's work phone number. Generally not used to contact a patient. Invalid numbers in a GET will be ignored. Patient phone numbers and other data may change, and one phone number may be associated with multiple patients. You are responsible for taking additional steps to verify patient identity and for using this data in accordance with applicable law, including HIPAA. Only phone numbers that exist in the North American Naming Plan (NANP) are acceptable for input. | String | 0..1 | Patient | telecom[*].value | system=phone,use=work | - | - | Top Level |
| zip | - | Patient's zip. Matching occurs on first 5 characters. | String | 0..1 | Patient | address[1].postalcode | - | - | - | Top Level |
| agriculturalworker | - | Used to identify this patient as an agricultural worker. Only settable if client has Social Determinant fields turned on. | String | 0..1 | QuestionnaireResponse | item[*].valueString | linkId=agriculturalworker | - | - | Contained |
| agriculturalworkertype | - | For patients that are agricultural workers, identifies the type of worker. Only settable if client has Social Determinant fields turned on. | String | 0..1 | QuestionnaireResponse | item[*].valueString | linkId=agriculturalworkertype | - | - | Contained |
| altfirstname | - | Alternate first name that differs from legal name. (Max length: 20) | String | 0..1 | Patient | name[*].given[1] | use = usual | - | - | Top Level |
| assignedsexatbirth | - | Sex that this patient was assigned at birth. (Max length: 20) | String | 0..1 | Patient | extension[*].valueCode | - | - | http://hl7.org/fhir/us/core/StructureDefinition/us-core-birthsex | Top Level |
| caresummarydeliverypreference | - | The patient's preference for care summary delivery. | String | 0..1 | QuestionnaireResponse | item[*].valueString | linkId=caresummarydeliverypreference | - | - | Contained |
| clinicalordertypegroupid | - | The clinical order type group of the clinical provider (Prescription: 10, Lab: 11, Vaccinations: 16). | String | 0..1 | Patient | extension[*].valueString | - | - | clinical-order-type-group-id | Top Level |
| consenttocall | - | The flag is used to record the consent of a patient to receive automated calls per FCC requirements. The requested legal language is 'Entry of any telephone contact number constitutes written consent to receive any automated, prerecorded, and artificial voice telephone calls initiated by the Practice. To alter or revoke this consent, visit the Patient Portal 'Contact Preferences' page.' | Boolean | 0..1 | Consent | extension[*].valueBoolean | - | - | consent-to-call | Contained |
| contacthomephone | - | Emergency contact home phone. Invalid numbers in a GET/PUT will be ignored. Patient phone numbers and other data may change, and one phone number may be associated with multiple patients. You are responsible for taking additional steps to verify patient identity and for using this data in accordance with applicable law, including HIPAA. Invalid numbers in a POST will be ignored, possibly resulting in an error. | String | 0..1 | Patient | contact[1].telecom[*].value | system=phone,use=home | - | - | Top Level |
| contactmobilephone | - | Emergency contact mobile phone. Invalid numbers in a GET/PUT will be ignored. Patient phone numbers and other data may change, and one phone number may be associated with multiple patients. You are responsible for taking additional steps to verify patient identity and for using this data in accordance with applicable law, including HIPAA. Invalid numbers in a POST will be ignored, possibly resulting in an error. | String | 0..1 | Patient | contact[1].telecom[*].value | system=phone,use=mobile | - | - | Top Level |
| contactname | - | The name of the (emergency) person to contact about the patient. The contactname, contactrelationship, contacthomephone, and contactmobilephone fields are all related to the emergency contact for the patient. They are NOT related to the contractpreference_* fields. (Max length: 20) | String | 0..1 | Patient | contact[1].name.text | - | - | - | Top Level |
| contactpreference | - | The MU-required field for 'preferred contact method'. This is not used by any automated systems. | String | 0..1 | Patient | contact[1].extension[*].valueString | - | - | contact-preference | Top Level |
| contactpreference_announcement_email | - | If set, the patient has indicated a preference to get or not get 'announcement' communications delivered via email. Note that this will not be present if the practice or patient has not set it.For completeness, turning email off is supported via the API, but it is discouraged. When email is off, patients may not not get messages from the patient portal. | Boolean | 0..1 | QuestionnaireResponse | item[*].valueBoolean | linkId=contactpreference_announcement_email | - | - | Contained |
| contactpreference_announcement_phone | - | If set, the patient has indicated a preference to get or not get 'announcement' communications delivered via phone. Note that this will not be present if the practice or patient has not set it. | Boolean | 0..1 | QuestionnaireResponse | item[*].valueBoolean | linkId=contactpreference_announcement_phone | - | - | Contained |
| contactpreference_announcement_sms | - | If set, the patient has indicated a preference to get or not get 'announcement' communications delivered via SMS. Note that this will not be present if the practice or patient has not set it.For SMS, there is specific terms of service language that must be used when displaying this as an option to be turned on. Turning on must be an action by the patient, not a practice user. | Boolean | 0..1 | QuestionnaireResponse | item[*].valueBoolean | linkId=contactpreference_announcement_sms | - | - | Contained |
| contactpreference_appointment_email | - | If set, the patient has indicated a preference to get or not get 'appointment' communications delivered via email. Note that this will not be present if the practice or patient has not set it.For completeness, turning email off is supported via the API, but it is discouraged. When email is off, patients may not not get messages from the patient portal. | Boolean | 0..1 | QuestionnaireResponse | item[*].valueBoolean | linkId=contactpreference_appointment_email | - | - | Contained |
| contactpreference_appointment_phone | - | If set, the patient has indicated a preference to get or not get 'appointment' communications delivered via phone. Note that this will not be present if the practice or patient has not set it. | Boolean | 0..1 | QuestionnaireResponse | item[*].valueBoolean | linkId=contactpreference_appointment_phone | - | - | Contained |
| contactpreference_appointment_sms | - | If set, the patient has indicated a preference to get or not get 'appointment' communications delivered via SMS. Note that this will not be present if the practice or patient has not set it.For SMS, there is specific terms of service language that must be used when displaying this as an option to be turned on. Turning on must be an action by the patient, not a practice user. | Boolean | 0..1 | QuestionnaireResponse | item[*].valueBoolean | linkId=contactpreference_appointment_sms | - | - | Contained |
| contactpreference_billing_email | - | If set, the patient has indicated a preference to get or not get 'billing' communications delivered via email. Note that this will not be present if the practice or patient has not set it.For completeness, turning email off is supported via the API, but it is discouraged. When email is off, patients may not not get messages from the patient portal. | Boolean | 0..1 | QuestionnaireResponse | item[*].valueBoolean | linkId=contactpreference_billing_email | - | - | Contained |
| contactpreference_billing_phone | - | If set, the patient has indicated a preference to get or not get 'billing' communications delivered via phone. Note that this will not be present if the practice or patient has not set it. | Boolean | 0..1 | QuestionnaireResponse | item[*].valueBoolean | linkId=contactpreference_billing_phone | - | - | Contained |
| contactpreference_billing_sms | - | If set, the patient has indicated a preference to get or not get 'billing' communications delivered via SMS. Note that this will not be present if the practice or patient has not set it.For SMS, there is specific terms of service language that must be used when displaying this as an option to be turned on. Turning on must be an action by the patient, not a practice user. | Boolean | 0..1 | QuestionnaireResponse | item[*].valueBoolean | linkId=contactpreference_billing_sms | - | - | Contained |
| contactpreference_lab_email | - | If set, the patient has indicated a preference to get or not get 'lab' communications delivered via email. Note that this will not be present if the practice or patient has not set it.For completeness, turning email off is supported via the API, but it is discouraged. When email is off, patients may not not get messages from the patient portal. | Boolean | 0..1 | QuestionnaireResponse | item[*].valueBoolean | linkId=contactpreference_lab_email | - | - | Contained |
| contactpreference_lab_phone | - | If set, the patient has indicated a preference to get or not get 'lab' communications delivered via phone. Note that this will not be present if the practice or patient has not set it. | Boolean | 0..1 | QuestionnaireResponse | item[*].valueBoolean | linkId=contactpreference_lab_phone | - | - | Contained |
| contactpreference_lab_sms | - | If set, the patient has indicated a preference to get or not get 'lab' communications delivered via SMS. Note that this will not be present if the practice or patient has not set it.For SMS, there is specific terms of service language that must be used when displaying this as an option to be turned on. Turning on must be an action by the patient, not a practice user. | Boolean | 0..1 | QuestionnaireResponse | item[*].valueBoolean | linkId=contactpreference_lab_sms | - | - | Contained |
| contactrelationship | - | Emergency contact relationship (one of SPOUSE, PARENT, CHILD, SIBLING, FRIEND, COUSIN, GUARDIAN, OTHER) | String | 0..1 | Patient | contact[1].relationship[1].coding[1].display | code=EP, system=http://terminology.hl7.org/3.1.0/CodeSystem-v2-0131.html | - | - | Top Level |
| countrycode3166 | - | US Patient's country code (ISO 3166-1) (Max length: 20) | String | 0..1 | Patient | address[1].country | - | - | - | Top Level |
| deceaseddate | - | If present, the date on which a patient died. | String | 0..1 | Patient | deceasedDateTime | - | - | - | Top Level |
| defaultpharmacyncpdpid | - | The NCPDP ID of the patient's preferred pharmacy. See http://www.ncpdp.org/ for details. Note: if updating this field, please make sure to have a CLINICALORDERTYPEGROUPID field as well. | String | 0..1 | Patient | extension[*].valueString | - | - | default-pharmacyncpdp-id | Top Level |
| donotcallyn | - | Warning! This patient will not receive any communication from the practice if this field is set to true. This field should only be used if you are absolutely certain that's what you want to do. | Boolean | 0..1 | QuestionnaireResponse | item[*].valueBoolean | linkId=donotcallyn | - | - | Contained |
| driverslicenseexpirationdate | - | The expiration date of the patient's driver's license. | String | 0..1 | Patient | identifier[*].period.end | - | - | Top Level | |
| driverslicensenumber | - | The number of the patient's driver's license (Max length: 20) | String | 0..1 | Patient | identifier[*].value | type=DL, use=official | - | - | Top Level |
| driverslicensestateid | - | The state of the patient's driver's license. This is in the form of a 2 letter state code. | String | 0..1 | Patient | identifier[*].assigner.reference | - | - | Top Level | |
| employerid | - | The patient's employer's ID (from /employers call) | Integer | 0..1 | RelatedPerson | id | relationship[].coding[].code=E,relationship[].coding[].system=http://terminology.hl7.org/CodeSystem/v2-0131,relationship\[_].coding\[_].display=Employer | - | - | Contained |
| employerphone | - | The patient's employer's phone number. Normally, this is set by setting employerid. However, setting this value can be used to override this on an individual patient. Invalid numbers in a GET/PUT will be ignored. Patient phone numbers and other data may change, and one phone number may be associated with multiple patients. You are responsible for taking additional steps to verify patient identity and for using this data in accordance with applicable law, including HIPAA. Invalid numbers in a POST will be ignored, possibly resulting in an error. | String | 0..1 | RelatedPerson | telecom[*].value | system=phone | - | - | Contained |
| ethnicitycodes | - | Ethnicities of the patient, using the 2.16.840.1.113883.5.50 codeset. See http://www.hl7.org/implement/standards/fhir/terminologies-v3.html Special case: use 'declined' to indicate that the patient declined to answer. Multiple values or a tab-seperated list of codes is acceptable for multiple ethnicities for input. The first ethnicity will be considered 'primary'. Note: you must update all values at once if you update any. THIS FIELD IS ONLY AVAILABLE WHEN COLPROM_MDP_PATIENT_API_ETHNICITYIDS IS ON. | String | 0..1 | Patient | extension[*].valueString | - | - | ethnicity-codes | Top Level |
| genderidentity | - | Gender with which this patient identifies. To see the available options for this input, please see GET /configuration/patients/genderidentity?show2015edcehrtvalues=true (Max length: 20) | String | 0..1 | Patient | gender | - | - | - | Top Level |
| genderidentityother | - | Only valid when used in conjunction with a gender identity choice that allows the patient to describe their identity (if it doesn't conform to any other choice). (Max length: 20) | String | 0..1 | Patient | extension[*].valueString | - | - | gender-identity-other | Top Level |
| guarantoraddress1 | - | Guarantor's address (Max length: 100) | String | 0..1 | RelatedPerson | address[1].line[1] | - | - | Contained | |
| guarantoraddress2 | - | Guarantor's address - line 2 (Max length: 100) | String | 0..1 | RelatedPerson | address[1].line[2] | - | - | - | Contained |
| guarantoraddresssameaspatient | - | If set, the address of the guarantor is the same as the patient. | Boolean | 0..1 | RelatedPerson | extension[*].valueBoolean | - | - | guarantor-address-same-as-patient | Contained |
| guarantorcity | - | Guarantor's city (Max length: 30) | String | 0..1 | RelatedPerson | address[1].city | - | - | - | Contained |
| guarantorcountrycode3166 | - | Guarantor's country code (ISO 3166-1) (Max length: 20) | String | 0..1 | RelatedPerson | address[1].country | - | - | - | Contained |
| guarantordob | - | Guarantor's DOB (mm/dd/yyyy) | String | 0..1 | RelatedPerson | birthdate | - | - | - | Contained |
| guarantoremail | - | Guarantor's email address | String | 0..1 | RelatedPerson | telecom[*].value | system=email | - | - | Contained |
| guarantoremployerid | - | The guaranror's employer's ID (from /employers call) | Integer | 0..1 | RelatedPerson | extension[*].valueId | - | - | gurantor-employee-id | Contained |
| guarantorfirstname | - | Guarantor's first name (Max length: 20) | String | 0..1 | RelatedPerson | name[1].given[1] | - | - | Contained | |
| guarantorlastname | - | Guarantor's last name (Max length: 20) | String | 0..1 | RelatedPerson | name[1].family | - | - | - | Contained |
| guarantormiddlename | - | Guarantor's middle name (Max length: 20) | String | 0..1 | RelatedPerson | name[1].given[2] | - | - | - | Contained |
| guarantorphone | - | Guarantor's phone number. Invalid numbers in a GET/PUT will be ignored. Patient phone numbers and other data may change, and one phone number may be associated with multiple patients. You are responsible for taking additional steps to verify patient identity and for using this data in accordance with applicable law, including HIPAA. Invalid numbers in a POST will be ignored, possibly resulting in an error. | String | 0..1 | RelatedPerson | telecom[*].value | system=phone | - | - | Contained |
| guarantorrelationshiptopatient | - | 1 The guarantor's relationship to the patient | String | 0..1 | RelatedPerson | relationship[].coding[].display | relationship[].coding[].code=O, relationship[*].text=Guarantor | - | - | Contained |
| guarantorssn | - | Guarantor's SSN | String | 0..1 | RelatedPerson | identifier[*].value | system="https://xcaliberapis.structureDefinition/guarantor-ssn" | - | - | Contained |
| guarantorstate | - | Guarantor's state (2 letter abbreviation) | String | 0..1 | RelatedPerson | address[1].state | - | - | - | Contained |
| guarantorsuffix | - | Guarantor's name suffix (Max length: 20) | String | 0..1 | RelatedPerson | name[1].suffix | - | - | - | Contained |
| guarantorzip | - | Guarantor's zip | String | 0..1 | RelatedPerson | address[1].postalCode | - | - | - | Contained |
| guardianfirstname | - | The first name of the patient's guardian. | String | 0..1 | RelatedPerson | name[1].given[1] | relationship[].coding[].code=O, relationship[*].text=Guardian | - | - | Contained |
| guardianlastname | - | The last name of the patient's guardian. | String | 0..1 | RelatedPerson | name[1].family | - | - | - | Contained |
| guardianmiddlename | - | The middle name of the patient's guardian. | String | 0..1 | RelatedPerson | name[1].given[2] | - | - | - | Contained |
| guardiansuffix | - | The suffix of the patient's guardian. | String | 0..1 | RelatedPerson | name[1].suffix | - | - | - | Contained |
| hasmobileyn | - | Set to false if a client has declined a phone number. | Boolean | 0..1 | QuestionnaireResponse | item[*].valueBoolean | linkId=hasmobileyn | - | - | Contained |
| homeboundyn | - | If the patient is homebound, this is true. | Boolean | 0..1 | QuestionnaireResponse | item[*].valueBoolean | linkId=homeboundyn | - | - | Contained |
| homeless | - | Used to identify this patient as homeless. Only settable if client has Social Determinant fields turned on. | String | 0..1 | QuestionnaireResponse | item[*].valueString | linkId=homeless | - | - | Contained |
| homelesstype | - | For patients that are homeless, provides more detail regarding the patient's homeless situation. Only settable if client has Social Determinant fields turned on. | String | 0..1 | QuestionnaireResponse | item[*].valueString | linkId=homelesstype | - | - | Contained |
| ignorerestrictions | - | Set to true to allow ability to find patients with record restrictions and blocked patients. This should only be used when there is no reflection to the patient at all that a match was found or not found. | Boolean | Patient | extension[*].valueBoolean | - | - | ignore-restrictions | Top Level | |
| industrycode | - | Industry of the patient, using the US Census industry code (code system 2.16.840.1.113883.6.310). 'other' can be used as well. | String | 0..1 | Patient | identifier[*].value | system=US Census industry code (code system 2.16.840.1.113883.6.310) | - | - | Top Level |
| language6392code | - | Language of the patient, using the ISO 639.2 code. (http://www.loc.gov/standards/iso639-2/php/code\_list.php; 'T' or terminology code) Special case: use 'declined' to indicate that the patient declined to answer. | String | 0..1 | Patient | communication[].language.coding[].code | system=ISO 639.2 | - | - | Top Level |
| maritalstatus | - | Marital Status (D=Divorced, M=Married, S=Single, U=Unknown, W=Widowed, X=Separated, P=Partner) | String | 0..1 | Patient | maritalstatus | - | - | - | Top Level |
| mobilecarrierid | - | The ID of the mobile carrier, from /mobilecarriers or the list below. | String | 0..1 | Patient | extension[*].valueString | - | - | mobile-carrier-id | Top Level |
| nextkinname | - | The full name of the next of kin. | String | 0..1 | RelatedPerson | name[1].given[1] | relationship[].coding[].code=N | - | - | Contained |
| nextkinphone | - | The next of kin phone number. Invalid numbers in a GET/PUT will be ignored. Patient phone numbers and other data may change, and one phone number may be associated with multiple patients. You are responsible for taking additional steps to verify patient identity and for using this data in accordance with applicable law, including HIPAA. Invalid numbers in a POST will be ignored, possibly resulting in an error. | String | 0..1 | RelatedPerson | telecom[*].value | system=phone | - | - | Contained |
| nextkinrelationship | - | The next of kin relationship (one of SPOUSE, PARENT, CHILD, SIBLING, FRIEND, COUSIN, GUARDIAN, OTHER) | String | 0..1 | RelatedPerson | relationship[].coding[].display | - | - | - | Contained |
| notes | - | Notes associated with this patient. | String | 0..1 | Patient | extension[*].valueString | - | - | notes | Top Level |
| occupationcode | - | Occupation of the patient, using the US Census occupation code (code system 2.16.840.1.113883.6.240). 'other' can be used as well. | String | 0..1 | Patient | identifier[*].value | system=US Census occupation code (code system 2.16.840.1.113883.6.240) | - | - | Top Level |
| onlinestatementonlyyn | - | Set to true if a patient wishes to get e-statements instead of paper statements. Should only be set for patients with an email address and clients with athenaCommunicator. The language we use in the portal is, 'Future billing statements will be sent to you securely via your Patient Portal account. You will receive an email notice when new statements are available.' This language is not required, but it is given as a suggestion. | Boolean | 0..1 | QuestionnaireResponse | item[*].valueBoolean | linkId=onlinestatementonlyyn | - | - | Contained |
| portalaccessgiven | - | This flag is set if the patient has been given access to the portal. This may be set by the API user if a patient has been given access to the portal 'by providing a preprinted brochure or flyer showing the URL where patients can access their Patient Care Summaries.' The practiceinfo endpoint can provide the portal URL. While technically allowed, it would be very unusual to set this to false via the API. | Boolean | 0..1 | Patient | extension[*].valueBoolean | - | - | portal-access-given | Top Level |
| povertylevelcalculated | - | Patient's poverty level (% of the Federal Poverty Level), as calculated from family size, income per pay period, pay period, and state. Typically only valued if client has Federal Poverty Level fields turned on. | Number | 0..1 | QuestionnaireResponse | item[*].valueDecimal | linkId=povertylevelcalculated | - | - | Contained |
| povertylevelfamilysize | - | Patient's family size (used for determining poverty level). Only settable if client has Federal Poverty Level fields turned on. | Number | 0..1 | QuestionnaireResponse | item[*].valueDecimal | linkId=povertylevelfamilysize | - | - | Contained |
| povertylevelfamilysizedeclined | - | Indicates if the patient delcines to provide 'povertylevelfamilysize'. Should be set to Yes if the patient declines. | Boolean | 0..1 | QuestionnaireResponse | item[*].valueBoolean | linkId=povertylevelfamilysizedeclined | - | - | Contained |
| povertylevelincomedeclined | - | Indicates if the patient delcines to provide 'povertylevelincomeperpayperiod'. Should be set to Yes if the patient declines. | Boolean | 0..1 | QuestionnaireResponse | item[*].valueBoolean | linkId=povertylevelincomedeclined | - | - | Contained |
| povertylevelincomepayperiod | - | Patient's pay period (used for determining poverty level). Only settable if client has Federal Poverty Level fields turned on. | String | 0..1 | QuestionnaireResponse | item[*].valueString | linkId=povertylevelincomepayperiod | - | - | Contained |
| povertylevelincomeperpayperiod | - | Patient's income per specified pay period (used for determining poverty level). Only settable if client has Federal Poverty Level fields turned on. | Integer | 0..1 | QuestionnaireResponse | item[*].valueInteger | linkId=povertylevelincomeperpayperiod | - | - | Contained |
| povertylevelincomerangedeclined | - | Indicates whether or not the patient declines to provide an income level (povertylevelcalculated). | Boolean | 0..1 | QuestionnaireResponse | item[*].valueBoolean | linkId=povertylevelincomerangedeclined | - | - | Contained |
| preferredname | - | The patient's preferred name (i.e. nickname). | String | 0..1 | Patient | name[*].given[1] | use = old | - | - | Top Level |
| preferredpronouns | - | Pronoun this patient uses. (Max length: 20) | String | Patient | extension[*].valueString | - | preferred-pronouns | Top Level | ||
| primarydepartmentid | - | The patient's 'current' department. This field is not always set by the practice. | String | 0..1 | Patient | extension[*].valueString | - | - | primary-department-id | Top Level |
| publichousing | - | Used to identify this patient as living in public housing. Only settable if client has Social Determinant fields turned on. | String | 0..1 | QuestionnaireResponse | item[*].valueString | linkId=publichousing | - | - | Contained |
| referralsourceid | - | The referral / 'how did you hear about us' ID. | String | 0..1 | Patient | extension[*].valueString | - | - | referral-source-id | Top Level |
| referralsourceother | - | If selecting 'other' for referral source, this is the text field that can be filled out. (Max length: 20) | String | Patient | extension[*].valueString | - | - | referral-source-other | Top Level | |
| schoolbasedhealthcenter | - | Used to identify this patient as school-based health center patient. Only settable if client has Social Determinant fields turned on. | String | 0..1 | QuestionnaireResponse | item[*].valueString | linkId=schoolbasedhealthcenter | - | - | Contained |
| sexualorientation | - | Sexual orientation of this patient. (Max length: 20) | String | 0..1 | Patient | extension[*].valueString | - | - | sexual-orientation | Top Level |
| sexualorientationother | - | Straight or heterosexual. Only valid when used in conjunction with a sexual orientation choice that allows the patient to describe their orientation (if it doesn't conform to any other choice). (Max length: 20) | String | 0..1 | Patient | extension[*].valueString | - | - | sexual-orientation-other | Top Level |
| status | - | a The 'status' of the patient, one of active, inactive, prospective, or deleted. | String | 0..1 | Patient | extension[*].valueString | - | - | status | Top Level |
| suffix | - | Patient's name suffix (Max length: 20) | String | 0..1 | Patient | name[*].suffix | use = official | - | - | Top Level |
| veteran | - | Used to identify this patient as a veteran. Only settable if client has Social Determinant fields turned on. | String | 0..1 | QuestionnaireResponse | item[*].valueString | linkId=veteran | - | - | Contained |
| name | - | String | Patient | name[*].text | use = official | - | - | Top Level | ||
| state | - | Patient's state (2 letter abbreviation) | String | 0..1 | Patient | address[1].state | - | - | - | Top Level |
| ssn | - | Social security number | String | 0..1 | Patient | identifier[*].value | system=http://hl7.org/fhir/sid/us-ssn | - | - | Top Level |
| lastmodified(chart alert) | - | The time this note was updated (mm/dd/yyyy hh24:mi:ss; Eastern time), if the note has been updated. | string | 0..1 | Patient | extension[*].valueDateTime | chart-alert-last-modified | Top Level | ||
| lastmodifiedby(chart alert) | - | If the note has been modified, the username who last modified this note. | string | 0..1 | Patient | extension[*].valueString | chart-alert-last-modified-by | Top Level | ||
| notetext(chart alert) | - | The text of the note. | string | 0..1 | Patient | extension[*].valueString | chart-alert-note-text | Top Level | ||
| countrycode | - | US Patient's country code (ISO 3166-1) (Max length: 20) | String | 0..1 | Patient | address[1].country | - | - | - | Top Level |